DurableInput

All Superinterfaces:

AutoCloseable, Closeable, DataInput
```
public interface DurableInput
extends DataInput, Closeable, AutoCloseable
```
A cross between DataInput and ByteBuffer. Provides utility methods for writing Bifurcan-specific values such as readVLQ() and readUVLQ(), as well as ways to slice out delimited blocks via sliceBlock(BlockPrefix.BlockType) et al.
All instances of DurableInput are presumed to be thread-local. If you need to hold onto the instance for future decoding, store the result of pool() and then call DurableInput.Pool.instance() when you want to resume decoding.

Nested Class Summary

Nested Classes
Modifier and Type	Interface and Description
`static class`	`DurableInput.Bounds` Describes the slice window for a `DurableInput`, which can be recursively followed to the root.
`static interface`	`DurableInput.Pool` A means of generating thread-local `DurableInput`s, which do not need to be explicitly released.

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`default InputStream`	`asInputStream()`
`DurableInput.Bounds`	`bounds()`
`void`	`close()` Closes the input, freeing any resources associated with it.
`DurableInput`	`duplicate()`
`static DurableInput`	`from(Iterable<DurableInput> inputs)` Constructs an input from the concatenation of one or more `inputs`.
`default boolean`	`hasRemaining()`
`default String`	`hexBytes()`
`default io.lacuna.bifurcan.durable.BlockPrefix`	`peekPrefix()` Reads but does not advance past the next block prefix.
`DurableInput.Pool`	`pool()`
`long`	`position()`
`int`	`read(ByteBuffer dst)` Copies as many byte as possible into `dst`, and returns the number of bytes.
`default boolean`	`readBoolean()` Reads and advances past the next byte, treating any non-zero value as `true`.
`byte`	`readByte()` Reads and advances past the next `int8` value.
`char`	`readChar()` Reads and advances past the next `int16` value.
`double`	`readDouble()` Reads and advances past the next `float64` value.
`float`	`readFloat()` Reads and advances past the next `float32` value.
`default void`	`readFully(byte[] b)` Copies bytes into `b`, throwing an `EOFException` if there are not enough bytes to fill it.
`default void`	`readFully(byte[] b, int off, int len)` Copies bytes into `b`, starting at `offset`, throwing an `EOFException` if there are not `len` bytes available.
`int`	`readInt()` Reads and advances past the next `int32` value.
`default String`	`readLine()`
`long`	`readLong()` Reads and advances past the next `int64` value.
`default io.lacuna.bifurcan.durable.BlockPrefix`	`readPrefix()` Reads and advances past the next block prefix.
`short`	`readShort()` Reads and advances past the next `int16` value.
`default int`	`readUnsignedByte()` Reads and advances past the next `uint8` value.
`default long`	`readUnsignedInt()` Reads and advances past the next `uint32` value.
`default int`	`readUnsignedShort()` Reads and advances past the next `uint16` value.
`default String`	`readUTF()`
`default long`	`readUVLQ()` Reads and advances past the next unsigned variable-length quantity, which works as described here.
`default long`	`readVLQ()` Reads and advances past the next signed variable-length quantity, which uses the first bit to encode the sign, and then works as described here.
`long`	`remaining()`
`DurableInput`	`seek(long position)` Updates the position of the input, and returns itself.
`default long`	`size()`
`default long`	`skipBlock()` Advances to the end of the block beginning at the current position.
`default int`	`skipBytes(int n)` Advances the position by `n` bytes.
`default long`	`skipBytes(long n)` Advances the position by `n` bytes;
`DurableInput`	`slice(long start, long end)`
`default DurableInput`	`sliceBlock(io.lacuna.bifurcan.durable.BlockPrefix.BlockType type)` Returns an input representing the contents of a block beginning at the current position, and advances the position to the end of that block.
`default DurableInput`	`sliceBytes(long bytes)` Returns an input representing the byte interval between `[position(), position() + bytes)`, and advances the position by `bytes`.
`default DurableInput`	`slicePrefixedBlock()` Returns an input representing a block (with the prefix included) beginning at the current position, and advances the position to the end of that block.

- Method Detail
  - from
```
static DurableInput from(Iterable<DurableInput> inputs)
```
    Constructs an input from the concatenation of one or more inputs.
  - slice
```
DurableInput slice(long start,
                   long end)
```
    Returns:
    
    an input representing the byte interval between [start, end)
  - sliceBytes
```
default DurableInput sliceBytes(long bytes)
```
    Returns an input representing the byte interval between [position(), position() + bytes), and advances the position by bytes.
  - sliceBlock
```
default DurableInput sliceBlock(io.lacuna.bifurcan.durable.BlockPrefix.BlockType type)
```
    Returns an input representing the contents of a block beginning at the current position, and advances the position to the end of that block. Asserts that the block prefix is the type provided, otherwise throws an IllegalStateException.
  - slicePrefixedBlock
```
default DurableInput slicePrefixedBlock()
```
    Returns an input representing a block (with the prefix included) beginning at the current position, and advances the position to the end of that block.
  - close
```
void close()
```
    Closes the input, freeing any resources associated with it.
    
    Specified by:
    
    close in interface AutoCloseable
    
    Specified by:
    
    close in interface Closeable
  - hexBytes
```
default String hexBytes()
```
    Returns:
    
    a hexdump style 16-byte wide hexadecimal table representation the complete contents of the input
  - bounds
```
DurableInput.Bounds bounds()
```
  - duplicate
```
DurableInput duplicate()
```
    Returns:
    
    an identical input, with the same position, but with an independently movable cursor
  - seek
```
DurableInput seek(long position)
```
    Updates the position of the input, and returns itself.
  - remaining
```
long remaining()
```
    Returns:
    
    the number of bytes between the end of the input and the current position
  - pool
```
DurableInput.Pool pool()
```
    Returns:
    
    a pool that can be used to provide future access to this input, potentially on another thread
  - hasRemaining
```
default boolean hasRemaining()
```
    Returns:
    
    true, if there are any bytes remaining in the input
  - position
```
long position()
```
    Returns:
    
    the position of the input
  - size
```
default long size()
```
    Returns:
    
    the total number of available bytes
  - read
```
int read(ByteBuffer dst)
```
    Copies as many byte as possible into dst, and returns the number of bytes.
  - readFully
```
default void readFully(byte[] b)
                throws EOFException
```
    Copies bytes into b, throwing an EOFException if there are not enough bytes to fill it.
    
    Specified by:
    
    readFully in interface DataInput
    
    Throws:
    
    EOFException
  - readFully
```
default void readFully(byte[] b,
                       int off,
                       int len)
                throws EOFException
```
    Copies bytes into b, starting at offset, throwing an EOFException if there are not len bytes available.
    
    Specified by:
    
    readFully in interface DataInput
    
    Throws:
    
    EOFException
  - skipBytes
```
default int skipBytes(int n)
```
    Advances the position by n bytes.
    
    Specified by:
    
    skipBytes in interface DataInput
  - skipBytes
```
default long skipBytes(long n)
```
    Advances the position by n bytes;
  - readByte
```
byte readByte()
```
    Reads and advances past the next int8 value.
    
    Specified by:
    
    readByte in interface DataInput
  - readShort
```
short readShort()
```
    Reads and advances past the next int16 value.
    
    Specified by:
    
    readShort in interface DataInput
  - readChar
```
char readChar()
```
    Reads and advances past the next int16 value.
    
    Specified by:
    
    readChar in interface DataInput
  - readInt
```
int readInt()
```
    Reads and advances past the next int32 value.
    
    Specified by:
    
    readInt in interface DataInput
  - readLong
```
long readLong()
```
    Reads and advances past the next int64 value.
    
    Specified by:
    
    readLong in interface DataInput
  - readFloat
```
float readFloat()
```
    Reads and advances past the next float32 value.
    
    Specified by:
    
    readFloat in interface DataInput
  - readDouble
```
double readDouble()
```
    Reads and advances past the next float64 value.
    
    Specified by:
    
    readDouble in interface DataInput
  - readVLQ
```
default long readVLQ()
```
    Reads and advances past the next signed variable-length quantity, which uses the first bit to encode the sign, and then works as described here.
  - readUVLQ
```
default long readUVLQ()
```
    Reads and advances past the next unsigned variable-length quantity, which works as described here.
  - readBoolean
```
default boolean readBoolean()
```
    Reads and advances past the next byte, treating any non-zero value as true.
    
    Specified by:
    
    readBoolean in interface DataInput
  - readUnsignedByte
```
default int readUnsignedByte()
```
    Reads and advances past the next uint8 value.
    
    Specified by:
    
    readUnsignedByte in interface DataInput
  - readUnsignedShort
```
default int readUnsignedShort()
```
    Reads and advances past the next uint16 value.
    
    Specified by:
    
    readUnsignedShort in interface DataInput
  - readUnsignedInt
```
default long readUnsignedInt()
```
    Reads and advances past the next uint32 value.
  - readLine
```
default String readLine()
```
    Specified by:
    
    readLine in interface DataInput
    
    Throws:
    
    UnsupportedOperationException
  - readUTF
```
default String readUTF()
```
    Specified by:
    
    readUTF in interface DataInput
  - readPrefix
```
default io.lacuna.bifurcan.durable.BlockPrefix readPrefix()
```
    Reads and advances past the next block prefix.
  - peekPrefix
```
default io.lacuna.bifurcan.durable.BlockPrefix peekPrefix()
```
    Reads but does not advance past the next block prefix.
  - skipBlock
```
default long skipBlock()
```
    Advances to the end of the block beginning at the current position.
  - asInputStream
```
default InputStream asInputStream()
```
    Returns:
    
    an InputStream corresponding to this input

Interface DurableInput

Nested Class Summary

Method Summary

Method Detail

from

slice

sliceBytes

sliceBlock

slicePrefixedBlock

close

hexBytes

bounds

duplicate

seek

remaining

pool

hasRemaining

position

size

read

readFully

readFully

skipBytes

skipBytes

readByte

readShort

readChar

readInt

readLong

readFloat

readDouble

readVLQ

readUVLQ

readBoolean

readUnsignedByte

readUnsignedShort

readUnsignedInt

readLine

readUTF

readPrefix

peekPrefix

skipBlock

asInputStream