Input device

Laws: readInput should return 0 on EOF.

Note: readInput is considered not thread-safe, e.g. A Input device can only be used with a single BufferedInput, If multiple BufferedInput s are opened on a same Input device, the behaviour will be undefined.

Output device

Laws: writeOutput should not return until all data are written (may not necessarily flushed to hardware, that should be done in device specific way).

Input device with buffer, NOT THREAD SAFE!

Request bytes from BufferedInput.

The buffering logic is quite simple:

If we have pushed back bytes, directly return it, otherwise we read using buffer size. If we read N bytes, and N is larger than half of the buffer size, then we freeze buffer and return, otherwise we copy buffer into result and reuse buffer afterward.

Push bytes back into buffer

Read buffer and parse with Parser.

Read exactly N bytes

If EOF reached before N bytes read, a ShortReadException will be thrown

Read until reach a magic bytes

If EOF is reached before meet a magic byte, partial bytes are returned.

Read until reach a magic bytes

If EOF is reached before meet a magic byte, a ShortReadException will be thrown.

Read to a linefeed ('\n' or '\r\n'), return Bytes before it.

If EOF is reached before meet a magic byte, partial line is returned.

Read to a linefeed ('\n' or '\r\n'), return Bytes before it.

If EOF reached before meet a magic byte, a ShortReadException will be thrown.

Output device with buffer, NOT THREAD SAFE!

Write Bytes into buffered handle.

Copy Bytes to buffer if it can hold, otherwise write both buffer(if not empty) and Bytes.

Write Bytes into buffered handle.

Copy Bytes to buffer if it can hold, otherwise write both buffer(if not empty) and Bytes.

Flush the buffer(if not empty).