driver/io.github.octaviusframework.driver.lo/LargeObject

LargeObject

class LargeObject(session: OctaviusSession, val oid: Int, val fd: Int) : AutoCloseable

Represents an open descriptor to a PostgreSQL Large Object. Implements AutoCloseable for convenient usage within .use { } blocks.

Constructors

LargeObject

internal constructor(session: OctaviusSession, oid: Int, fd: Int)

Properties

val fd: Int

The File Descriptor (FD) assigned by PostgreSQL for this open object.

oid

val oid: Int

The Object ID (OID) of this Large Object.

Functions

open override fun close()

Closes the Large Object descriptor, freeing server-side resources. It is safe to call this method multiple times; subsequent calls are ignored.

inputStream

fun inputStream(): InputStream

Returns an InputStream for reading from this Large Object. Closing the stream will close this Large Object.

outputStream

fun outputStream(): OutputStream

Returns an OutputStream for writing to this Large Object. Closing the stream will close this Large Object.

read

fun read(length: Int): ByteArray

Reads up to length bytes from the Large Object.

fun read(buffer: ByteArray, offset: Int = 0, length: Int = buffer.size - offset): Int

Reads up to length bytes from the Large Object into the given buffer.

seek

fun seek(position: Long, ref: Int = SeekWhence.SET): Long

Sets the current position of the Large Object.

tell

fun tell(): Long

Retrieves the current position of the Large Object.

truncate

fun truncate(length: Long)

Truncates the Large Object to the given length. If the object was previously larger, the extra data is lost. If the object was previously shorter, it is extended with null bytes.

write

fun write(data: ByteArray, offset: Int = 0, length: Int = data.size - offset)

Writes length bytes from the specified data byte array starting at offset to this Large Object.