core/org.gnit.lucenekmp.store/DataInput

DataInput

abstract class DataInput : Cloneable<DataInput>

Abstract base class for performing read operations of Lucene's low-level data types.

DataInput may only be used from one thread, because it is not thread safe (it keeps internal state like file position). To allow multithreaded use, every DataInput instance must be cloned before used in another thread. Subclasses must therefore implement .clone, returning a new DataInput which operates on the same underlying resource, but positioned independently.

Inheritors

Constructors

DataInput

constructor()

Functions

clone

open override fun clone(): DataInput

Returns a clone of this stream.

readByte

abstract fun readByte(): Byte

Reads and returns a single byte.

readBytes

abstract fun readBytes(b: ByteArray, offset: Int, len: Int)

Reads a specified number of bytes into an array at the specified offset.

open fun readBytes(b: ByteArray, offset: Int, len: Int, useBuffer: Boolean)

Reads a specified number of bytes into an array at the specified offset with control over whether the read should be buffered (callers who have their own buffer should pass in "false" for useBuffer). Currently only BufferedIndexInput respects this parameter.

readFloats

open fun readFloats(floats: FloatArray, offset: Int, len: Int)

Reads a specified number of floats into an array at the specified offset.

readGroupVInt

open fun readGroupVInt(dst: IntArray, offset: Int)

Override if you have an efficient implementation. In general this is when the input supports random access.

readInt

open fun readInt(): Int

Reads four bytes and returns an int (LE byte order).

readInts

open fun readInts(dst: IntArray, offset: Int, length: Int)

Reads a specified number of ints into an array at the specified offset.

readLong

open fun readLong(): Long

Reads eight bytes and returns a long (LE byte order).

readLongs

open fun readLongs(dst: LongArray, offset: Int, length: Int)

Read a specified number of longs.

readMapOfStrings

open fun readMapOfStrings(): MutableMap<String, String>

Reads a Map previously written with .

readSetOfStrings

open fun readSetOfStrings(): MutableSet<String>

Reads a Set previously written with DataOutput.writeSetOfStrings.

readShort

open fun readShort(): Short

Reads two bytes and returns a short (LE byte order).

readString

open fun readString(): String

Reads a string.

readVInt

open fun readVInt(): Int

Reads an int stored in variable-length format. Reads between one and five bytes. Smaller values take fewer bytes. Negative numbers are supported, but should be avoided.

readVLong

open fun readVLong(): Long

Reads a long stored in variable-length format. Reads between one and nine bytes. Smaller values take fewer bytes. Negative numbers are not supported.

readZInt

open fun readZInt(): Int

Read a zig-zag-encoded .readVInt integer.

readZLong

open fun readZLong(): Long

Read a zig-zag-encoded .readVLong integer. Reads between one and ten bytes.

skipBytes

abstract fun skipBytes(numBytes: Long)

Skip over numBytes bytes. This method may skip bytes in whatever way is most optimal, and may not have the same behavior as reading the skipped bytes. In general, negative numBytes are not supported.