Struct WireReader

Source

pub struct WireReader<'a, const E: bool = true> { /* private fields */ }

Expand description

A wrapper around a &[u8] slice that provides an easy interface for reading data types from the slice.

Implementations§

Source §

impl<'a, const E: bool> WireReader<'a, E>

Source

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

Create a WireReader that can read data types sequentially from the bytes slice.

The generic boolean E designates the intended endianness of the data being read. If E is set to true, then the data will be deserialized in big endian format; if false, it will be deserialized in little endian. If unset, this will default to true, or big endian.

Source

pub fn advance(&mut self, amount: usize) -> Result<(), WireError>

Advance the reader’s index forward by the given amount of bytes, returning an error if there are insufficient bytes on the wire to do so.

Source

pub fn advance_up_to(&mut self, amount: usize)

Advance the reader’s index forward by the given number of bytes, or to the end of the wire if the amount exceeds the number of remaining bytes.

Source

pub fn finalize(&self) -> Result<(), WireError>

Check if the reader has no more bytes left on the wire that can be read. If any bytes remain, return WireError::ExtraBytes; otherwise, return Ok().

Source

pub fn finalize_after<T>( action: Result<T, WireError>, reader: &Self, ) -> Result<T, WireError>

Check if the reader has no more bytes left on the wire that can be read after the given action. If any bytes remain, return WireError::ExtraBytes; otherwise, return Ok().

Source

pub fn is_empty(&self) -> bool

Check whether the reader has any remaining bytes to be read.

Source

pub fn peek<T>(&self) -> Result<T, WireError>
where T: WireRead,

Read the given data type T from the wire without advancing the index of the reader.

Source

pub fn peek_comp<T>(&self) -> Result<T, WireError>
where T: WireReadComp<'a>,

Read the given data type T from the wire without advancing the index of the reader.

Source

pub fn peek_part<T, const L: usize>(&mut self) -> Result<T, WireError>
where T: WireReadPart,

Read the given data type T from L bytes on the wire without advancing the index of the reader.

Source

pub fn peek_ref<T>(&mut self, size: usize) -> Result<&'a T, WireError>
where T: WireReadRef + ?Sized,

Read the given data type T from size bytes on the wire without advancing the index of the reader.

Source

pub fn read<T>(&mut self) -> Result<T, WireError>
where T: WireRead,

Read the given data type T from the wire.

Source

pub fn read_comp<T>(&mut self) -> Result<T, WireError>
where T: WireReadComp<'a>,

Read the given data type T from the wire.

Source

pub fn read_part<T, const L: usize>(&mut self) -> Result<T, WireError>
where T: WireReadPart,

Read the given data type T from size bytes on the wire.

Source

pub fn read_ref<T>(&mut self, size: usize) -> Result<&'a T, WireError>
where T: WireReadRef + ?Sized,

Read the given data type T from the wire.

Source

pub fn read_remaining<T>(&mut self) -> Result<&'a T, WireError>
where T: WireReadRef + ?Sized,

Read the given data type T from the remaining data on the wire. Note that this operation may succeed even if there are no bytes remaining on the wire for the given reader.