Struct BytesCursor 

pub struct BytesCursor { /* private fields */ }

BytesCursor is a Bytes wrapper implementing Input.

It supports zero-copy decoding of Bytes fields, and provides a read_bytes method which can be used to implement zero-copy decoding of other types.

Implementations

impl BytesCursor

pub fn is_empty(&self) -> bool

Returns true iff there are no bytes left to read.

pub fn infallible_remaining_len(&self) -> usize

Returns the number of bytes left to read.

Note that this is “infallible” in contrast to Input::remaining_len, which can return Err or Ok(None).

pub fn remaining(&mut self) -> &Bytes

Returns a reference to a Bytes object containing the remaining bytes.

The length of the Bytes should match self.infallible_remaining_len().

pub fn read_bytes(&mut self, len: usize) -> Result<Bytes, Error>

Read len bytes.

This is zero-copy; the returned Bytes uses the same underlying storage as the wrapped Bytes object.

pub fn decode_all<T: Decode>(&mut self) -> Result<T, Error>

Convenience method to decode a value and ensure all bytes are consumed.

Trait Implementations

impl From<Bytes> for BytesCursor

fn from(bytes: Bytes) -> Self

Converts to this type from the input type.

impl From<Vec<u8>> for BytesCursor

fn from(vec: Vec<u8>) -> Self

Converts to this type from the input type.

impl Input for BytesCursor

fn remaining_len(&mut self) -> Result<Option<usize>, Error>

Should return the remaining length of the input data. If no information about the input length is available, None should be returned.

fn read(&mut self, into: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill the given buffer.

fn read_byte(&mut self) -> Result<u8, Error>

Read a single byte from the input.

fn descend_ref(&mut self) -> Result<(), Error>

Descend into nested reference when decoding. This is called when decoding a new refence-based instance, such as Vec or Box. Currently, all such types are allocated on the heap.

fn ascend_ref(&mut self)

Ascend to previous structure level when decoding. This is called when decoding reference-based type is finished.

fn on_before_alloc_mem(&mut self, _size: usize) -> Result<(), Error>

Hook that is called before allocating memory on the heap.

impl LifetimeFree for BytesCursor