avail/avail.io/NybbleInputStream

NybbleInputStream

class NybbleInputStream(nybbles: NybbleArray, nybbleIndex: Int = 0) : InputStream, Iterable<Int>

NybbleInputStream reads from a NybbleArray.

Author

Todd L Smith

Parameters

nybbles

The NybbleArray that serves as the nybble source.

nybbleIndex

The zero-based index of the first nybble to read.

Constructors

NybbleInputStream

fun NybbleInputStream(nybbles: NybbleArray, nybbleIndex: Int = 0)

Functions

open override fun available(): Int

The exact number of nybbles that can be read before reaching the end-of-stream. Reading never blocks.

open override fun close()

open fun forEach(p0: Consumer<in Int>)

fun goTo(index: Int)

Move the read position to the specified index.

open operator override fun iterator(): Iterator<Int>

Answer an iterator that consumes nybbles from the receiver.

open override fun mark(readLimit: Int)

Set the mark. The read limit is ignored; any number of nybbles may be read without invalidating reset.

open override fun markSupported(): Boolean

Mark is supported.

open override fun read(): Int

open fun read(p0: ByteArray): Int

open fun read( p0: ByteArray, p1: Int, p2: Int): Int

open fun readAllBytes(): ByteArray

open fun readNBytes(p0: Int): ByteArray

open fun readNBytes( p0: ByteArray, p1: Int, p2: Int): Int

open override fun reset()

Reset the read position to the previous mark. If mark was never called on the receiver, then reset the read position to the beginning of the stream.

open override fun skip(n: Long): Long

open fun skipNBytes(p0: Long)

open fun spliterator(): Spliterator<Int>

open override fun toString(): String

open fun transferTo(p0: OutputStream): Long

Properties

val atEnd: Boolean

Whether the receiver is exhausted.

val position: Int

The read position.

Extensions

fun NybbleInputStream.opcode(): Int

Unapply the variable-length universal coding strategy applied by opcode to decode a nonnegative integer from the receiver. If the stored encoding does not denote a valid value, the result is undefined, and the number of bytes consumed is also undefined.

fun NybbleInputStream.unvlq(): Int

Unapply the variable-length universal coding strategy applied by vlq to decode a nonnegative integer from the receiver. If the stored encoding does not denote a valid value, the result is undefined, and the number of bytes consumed is also undefined.