driver/io.github.octaviusframework.driver.io/PgInputStream

PgInputStream

internal class PgInputStream(inputStream: InputStream)

A highly optimized, buffered input stream tailored for the PostgreSQL wire protocol.

It provides specialized methods for efficiently reading protocol primitives like bytes, integers, shorts, and null-terminated C-style strings. Internal buffering is used to minimize network reads and object allocations.

Constructors

PgInputStream

constructor(inputStream: InputStream)

Functions

changeStream

fun changeStream(newStream: InputStream)

Swaps the underlying stream, discarding whatever is still buffered from the old one.

hasPending

fun hasPending(): Boolean

Whether a read would find something without waiting: bytes left in the buffer, or bytes the underlying stream already holds.

readByte

fun readByte(): Byte

Reads one byte, refilling the buffer if it is spent.

readBytes

fun readBytes(length: Int): ByteArray

Returns exactly the specified number of bytes.

readCString

fun readCString(): String

Reads a null-terminated string.

readFully

fun readFully(bytes: ByteArray, length: Int = bytes.size)

Fills bytes with exactly length bytes, reading as many times as it takes.

readInt

fun readInt(): Int

Reads a 32-bit integer, most significant byte first.

readShort

fun readShort(): Short

Reads a 16-bit integer, most significant byte first.

skip

fun skip(length: Int)

Advances past exactly length bytes without materializing them.