core/org.gnit.lucenekmp.util/PagedBytes

PagedBytes

class PagedBytes(blockBits: Int) : Accountable

Represents a logical byte[] as a series of pages. You can write-once into the logical byte[] (append only), using copy, and then retrieve slices (BytesRef) into it using fill.

Constructors

PagedBytes

constructor(blockBits: Int)

Types

Companion

object Companion

PagedBytesDataInput

inner class PagedBytesDataInput : DataInput

Input that transparently iterates over pages

PagedBytesDataOutput

inner class PagedBytesDataOutput : DataOutput

Output that transparently spills to new pages as necessary

Reader

class Reader(pagedBytes: PagedBytes) : Accountable

Provides methods to read BytesRefs from a frozen PagedBytes.

Properties

childResources

open val childResources: MutableCollection<Accountable>

Returns nested resources of this class. The result should be a point-in-time snapshot (to avoid race conditions).

dataInput

val dataInput: PagedBytes.PagedBytesDataInput

dataOutput

val dataOutput: PagedBytes.PagedBytesDataOutput

pointer

val pointer: Long

Functions

copy

fun copy(in: IndexInput, byteCount: Long)

Read this many bytes from in

fun copy(bytes: BytesRef, out: BytesRef)

Copy BytesRef in, setting BytesRef out to the result. Do not use this if you will use freeze(true). This only supports bytes.length <= blockSize

copyUsingLengthPrefix

fun copyUsingLengthPrefix(bytes: BytesRef): Long

Copy bytes in, writing the length as a 1 or 2 byte vInt prefix.

freeze

fun freeze(trim: Boolean): PagedBytes.Reader

Commits final byte[], trimming it if necessary and if trim=true

ramBytesUsed

open override fun ramBytesUsed(): Long

Return the memory usage of this object in bytes. Negative values are illegal.