StreamingDataInput (OpenHFT/Chronicle-Bytes 1.0.14-beta API)

All Known Subinterfaces:

Bytes<Underlying>, net.openhft.chronicle.bytes.ByteStringParser<B>

All Known Implementing Classes:

AbstractBytes, MappedBytes, NativeBytes, UncheckedBytes, VanillaBytes
```
public interface StreamingDataInput<S extends StreamingDataInput<S>>
```
This data input has a a position() and a limit()

Method Summary

All Methods Instance Methods Abstract Methods Default Methods
Modifier and Type	Method and Description
`long`	`address(long offset)` Obtain the underlying address.
`default ByteOrder`	`byteOrder()`
`Bytes`	`bytesForRead()`
`Bytes`	`bytesForWrite()`
`default long`	`capacity()`
`S`	`clear()`
`default InputStream`	`inputStream()`
`void`	`nativeRead(long address, long size)` This is an expert level method for copying raw native memory in bulk.
`default <R> R`	`parseWithLength(long length, java.util.function.Function<S,R> bytesConsumer)`
`int`	`peekUnsignedByte()`
`default void`	`read(byte[] bytes)`
`default void`	`read(ByteBuffer buffer)`
`default boolean`	`readBoolean()`
`byte`	`readByte()`
`double`	`readDouble()`
`float`	`readFloat()`
`int`	`readInt()`
`default long`	`readLimit()`
`S`	`readLimit(long limit)`
`long`	`readLong()`
`default long`	`readPosition()`
`S`	`readPosition(long position)`
`default long`	`readRemaining()`
`short`	`readShort()`
`S`	`readSkip(long bytesToSkip)`
`default long`	`readStopBit()`
`default int`	`readUnsignedByte()`
`default long`	`readUnsignedInt()`
`default int`	`readUnsignedShort()`
`default String`	`readUTFΔ()` The same as readUTF() except the length is stop bit encoded.
`default <ACS extends Appendable & CharSequence> boolean`	`readUTFΔ(ACS sb)` The same as readUTFΔ() except the chars are copied to a truncated StringBuilder.
`int`	`readVolatileInt()`
`long`	`readVolatileLong()`
`default void`	`readWithLength(long length, java.util.function.Consumer<S> bytesConsumer)` Perform a set of actions with a temporary bounds mode.
`default long`	`start()`
`default long`	`writeLimit()`
`default long`	`writePosition()`
`default long`	`writeRemaining()`
`S`	`writeSkip(long bytesToSkip)`

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted
close, refCount, release, releaseAll, reserve, tryReserve

Methods inherited from interface net.openhft.chronicle.core.io.Closeable
closeQuietly

- Method Detail
  - readPosition
```
S readPosition(long position)
```
  - readLimit
```
S readLimit(long limit)
```
  - readWithLength
```
default void readWithLength(long length,
                            java.util.function.Consumer<S> bytesConsumer)
```
    Perform a set of actions with a temporary bounds mode.
  - parseWithLength
```
default <R> R parseWithLength(long length,
                              java.util.function.Function<S,R> bytesConsumer)
```
  - inputStream
```
default InputStream inputStream()
```
  - readStopBit
```
default long readStopBit()
```
  - readBoolean
```
default boolean readBoolean()
```
  - readByte
```
byte readByte()
```
  - readUnsignedByte
```
default int readUnsignedByte()
```
  - readShort
```
short readShort()
```
  - readUnsignedShort
```
default int readUnsignedShort()
```
  - readInt
```
int readInt()
```
  - readUnsignedInt
```
default long readUnsignedInt()
```
  - readLong
```
long readLong()
```
  - readFloat
```
float readFloat()
```
  - readDouble
```
double readDouble()
```
  - readUTFΔ
```
@Nullable
default String readUTFΔ()
```
    The same as readUTF() except the length is stop bit encoded. This saves one byte for strings shorter than 128 chars. null values are also supported
    
    Returns:
    
    a Unicode string or null if writeUTFΔ(null) was called
  - readUTFΔ
```
default <ACS extends Appendable & CharSequence> boolean readUTFΔ(ACS sb)
                                                          throws net.openhft.chronicle.bytes.UTFDataFormatRuntimeException
```
    The same as readUTFΔ() except the chars are copied to a truncated StringBuilder.
    
    Parameters:
    
    sb - to copy chars to
    
    Returns:
    
    true if there was a String, or false if it was null
    
    Throws:
    
    net.openhft.chronicle.bytes.UTFDataFormatRuntimeException
  - read
```
default void read(byte[] bytes)
```
  - read
```
default void read(ByteBuffer buffer)
```
  - readVolatileInt
```
int readVolatileInt()
```
  - readVolatileLong
```
long readVolatileLong()
```
  - peekUnsignedByte
```
int peekUnsignedByte()
```
  - nativeRead
```
void nativeRead(long address,
                long size)
```
    This is an expert level method for copying raw native memory in bulk.
    
    Parameters:
    
    address - of the memory.
    
    size - in bytes.
  - clear
```
S clear()
```
  - readSkip
```
S readSkip(long bytesToSkip)
```
  - writeSkip
```
S writeSkip(long bytesToSkip)
```
  - start
```
default long start()
```
    Returns:
    
    The smallest position allowed in this buffer.
  - capacity
```
default long capacity()
```
    Returns:
    
    the highest limit allowed for this buffer.
  - readPosition
```
default long readPosition()
```
  - writePosition
```
default long writePosition()
```
  - readRemaining
```
default long readRemaining()
```
  - writeRemaining
```
default long writeRemaining()
```
  - readLimit
```
default long readLimit()
```
    Returns:
    
    the highest offset or position allowed for this buffer.
  - writeLimit
```
default long writeLimit()
```
  - address
```
long address(long offset)
      throws UnsupportedOperationException
```
    Obtain the underlying address. This is for expert users only.
    
    Parameters:
    
    offset - within this buffer. address(start()) is the actual address of the first byte.
    
    Returns:
    
    the underlying address of the buffer
    
    Throws:
    
    UnsupportedOperationException - if the underlying buffer is on the heap
  - byteOrder
```
default ByteOrder byteOrder()
```
  - bytesForRead
```
Bytes bytesForRead()
```
    Returns:
    
    the streaming bytes for reading.
  - bytesForWrite
```
Bytes bytesForWrite()
```
    Returns:
    
    the streaming bytes for writing.

Interface StreamingDataInput<S extends StreamingDataInput<S>>

Method Summary

Methods inherited from interface net.openhft.chronicle.core.ReferenceCounted

Methods inherited from interface net.openhft.chronicle.core.io.Closeable

Method Detail

readPosition

readLimit

readWithLength

parseWithLength

inputStream

readStopBit

readBoolean

readByte

readUnsignedByte

readShort

readUnsignedShort

readInt

readUnsignedInt

readLong

readFloat

readDouble

readUTFΔ

readUTFΔ

read

read

readVolatileInt

readVolatileLong

peekUnsignedByte

nativeRead

clear

readSkip

writeSkip

start

capacity

readPosition

writePosition

readRemaining

writeRemaining

readLimit

writeLimit

address

byteOrder

bytesForRead

bytesForWrite