Struct BufferReader 

pub struct BufferReader<'a>(/* private fields */);

A zero-copy immutable byte-buffer reader.

Internally, it stores an offset that is increased during reading.

Implementations

impl<'a> BufferReader<'a>

pub fn new(buffer: &'a [u8]) -> Self

Creates a BufferReader from the given slice, without copying.

Inner offset is initialized to zero.

pub fn capacity(&self) -> usize

Returns the remaining capacity in the buffer.

pub fn offset(&self) -> usize

Returns the current offset of the buffer.

pub fn skip(&mut self, len: usize) -> Result<(), EndOfBuffer>

Advances the offset.

In case of Err the offset is not advanced.

pub fn buffer(&self) -> &'a [u8]

Returns a reference to the internal buffer.

Note: this is the entire buffer (despite offset).

pub fn buffer_remaining(&mut self) -> &'a [u8]

Returns the inner buffer starting from the current offset.

pub fn child(&mut self) -> BufferReaderChild<'a, '_>

Creates a BufferReaderChild with this parent.

Trait Implementations

impl<'a> BytesReader<'a> for BufferReader<'a>

fn get_varint(&mut self) -> Option<VarInt>

Reads an unsigned variable-length integer in network byte-order from the current offset and advances the offset.

fn get_bytes(&mut self, len: usize) -> Option<&'a [u8]>

Reads len bytes from the current offset without copying and advances the offset.

impl Debug for BufferReader<'_>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.