driver/io.github.octaviusframework.driver.io/PgByteWriter

PgByteWriter

class PgByteWriter(initialCapacity: Int = 1024, maxCapacity: Int = 65536)

Optimized buffer for building binary packets for the database. Allows reserving space for size and filling it later without memory copying.

Constructors

PgByteWriter

constructor(initialCapacity: Int = 1024, maxCapacity: Int = 65536)

Properties

data

var data: ByteArray

position

var position: Int

Functions

clear

fun clear()

Empties the buffer for the next packet, releasing the backing array if this one grew past maxCapacity.

fillLengthInt

fun fillLengthInt(markerIndex: Int)

Calculates the number of bytes added since reserveLengthInt was called and writes this value at the marker. Does not include the 4 bytes of the marker itself (in accordance with many PG structures).

reserveLengthInt

fun reserveLengthInt(): Int

Leaves 4 bytes of space for a number (e.g. packet size) and returns the index where this size should be written later.

toByteArray

fun toByteArray(): ByteArray

A copy of what has been written so far.

updatePosition

fun updatePosition(newPosition: Int)

Moves the write cursor, for the caller that has to go back and rewrite something it already emitted.

writeByte

fun writeByte(b: Byte)

Appends one byte.

writeBytes

fun writeBytes(bytes: ByteArray)

Appends bytes whole, with no length prefix — pair it with reserveLengthInt where the protocol wants one.

writeDouble

fun writeDouble(d: Double)

Appends a float8 as its IEEE 754 bit pattern.

writeFloat

fun writeFloat(f: Float)

Appends a float4 as its IEEE 754 bit pattern, which is the form PostgreSQL's binary format wants.

writeInt

fun writeInt(i: Int)

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

writeLong

fun writeLong(l: Long)

Appends a 64-bit integer, most significant byte first.

writeShort

fun writeShort(s: Short)

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