Buffer

Discard count readable bytes.

Create a new Buffer instance pointing to the same memory and having the same positions.

Read the next byte or fail with EOFException if it's not available. The returned byte is marked as consumed.

Reserve endGap bytes in the end. Could move readPosition and writePosition to reserve space but only when no bytes were written or all written bytes are marked as consumed (were read or discarded).

Reserve startGap bytes in the beginning. May move readPosition and writePosition if no bytes available for reading.

Clear buffer's state: read/write positions, gaps and so on. Byte content is not cleaned-up.

Marks the whole buffer available for read and no for write

Marks all capacity writable except the start gap reserved before. The end gap reservation is discarded.

Marks up to limit bytes of the buffer available for write and no bytes for read. It does respect startGap already reserved. All extra bytes after the specified limit are considered as endGap.

Rewind readPosition backward to make count bytes available for reading again.

Peek the next unsigned byte or return -1 if no more bytes available for reading. No bytes will be marked as consumed in any case.

Read the next unsigned byte or return -1 if no more bytes available for reading. The returned byte is marked as consumed.

Write a byte value at writePosition (incremented when written successfully).

Buffer's capacity (including reserved startGap and endGap). Value for released buffer is unspecified.

Number of bytes reserved in the end.

Write position limit. No bytes could be written ahead of this limit. When the limit is less than the capacity then this means that there are reserved bytes in the end (endGap). Such a reserved space in the end could be used to write size, hash and so on. Also it is useful when several buffers are connected into a chain and some primitive value (e.g. kotlin.Int) is separated into two chunks so bytes from the second chain could be copied to the reserved space of the first chunk and then the whole value could be read at once.

Current read position. It is always non-negative and will never run ahead of the writePosition. It is usually greater or equal to startGap reservation. This position is affected by discard, rewind, resetForRead, resetForWrite, reserveStartGap and reserveEndGap.

Number of bytes available for reading.

Start gap is a reserved space in the beginning. The reserved space is usually used to write a packet length in the case when it's not known before the packet constructed.

Current write position. It is always non-negative and will never run ahead of the limit. It is always greater or equal to the readPosition.

Size of the free space available for writing in bytes.

Write byte value repeated the specified times.

Write unsigned byte value repeated the specified times.

Write byte v value repeated n times.

For every byte from this buffer invokes block function giving it as parameter.

Push back n bytes: only possible if there were at least n bytes read before this operation.

Apply block of code with buffer's memory providing read range indices. The returned value of block lambda should return number of bytes to be marked as consumed. No read/write functions on this buffer should be called inside of block otherwise an undefined behaviour may occur including data damage.

Read available for read bytes to the destination array range starting at array offset and length bytes. If less than length bytes available then less bytes will be copied and the corresponding number will be returned as result.

Read available for read bytes to the destination array range starting at array offset and length elements. If less than length elements available then less elements will be copied and the corresponding number will be returned as result (possibly zero).

Read at most length available bytes to the dst buffer or -1 if no bytes available for read.

Read the specified number of bytes specified (optional, read all remaining by default)

Read a floating point number or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).

Read a floating point number or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).

Read from this buffer to the destination array to offset and length bytes.

Read from this buffer to the destination array to offset and length bytes. Numeric values are interpreted in the network byte order (Big Endian).

Read at most length bytes from this buffer to the dst buffer.

Read buffer's content to the destination buffer moving its position.

Read an integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).

Read a long integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).

Read a short integer or fail if no bytes available for reading. The numeric value is decoded in the network order (Big Endian).

Reads at most max characters decoding bytes with specified charset. Extra character bytes will remain unconsumed

Read an unsigned byte or fail if no bytes available for reading.

Read an unsigned integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).

Read an unsigned long integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).

Read an unsigned short integer or fail if not enough bytes available for reading. The numeric value is decoded in the network order (Big Endian).

Peek the next unsigned byte or return -1 if no more bytes available for reading. No bytes will be marked as consumed in any case.

Apply block of code with buffer's memory providing write range indices. The returned value of block lambda should return number of bytes were written. o read/write functions on this buffer should be called inside of block otherwise an undefined behaviour may occur including data damage.

Write a floating point number or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).

Write a floating point number or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).

Write the whole source array range staring at offset and having the specified bytes length.

Write the whole source array range staring at offset and having the specified items length. Numeric values are interpreted in the network byte order (Big Endian).

Write all readable bytes from src to this buffer. Fails if not enough space available to write all bytes.

Write at most length readable bytes from src to this buffer. Fails if not enough space available to write all bytes.

Write source buffer content moving its position.

Write an integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).

Write a long integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).

Write a short integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).

Write an unsigned byte or fail if not enough space available for writing.

Write an unsigned integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).

Write an unsigned long integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).

Write an unsigned short integer or fail if not enough space available for writing. The numeric value is encoded in the network order (Big Endian).