Struct ByteReader 

pub struct ByteReader<'a> { /* private fields */ }

A zero-copy big-endian reader confined to one declared byte region.

Implementations

impl<'a> ByteReader<'a>

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

Construct a reader whose owned outputs may contain at most allocation_budget bytes/items.

pub fn offset(&self) -> usize

Current absolute byte offset.

pub fn remaining(&self) -> usize

Bytes remaining in this reader’s declared region.

pub fn allocation_budget(&self) -> usize

Allocation budget inherited by values decoded from this region.

pub fn preflight_allocation(&self, amount: usize) -> Result<(), ByteError>

Reject an allocation before reserving it if its declared size exceeds the budget.

pub fn read_u1(&mut self) -> Result<u8, ByteError>

Read one byte.

pub fn read_u2(&mut self) -> Result<u16, ByteError>

Read an unsigned big-endian two-byte integer.

pub fn read_u4(&mut self) -> Result<u32, ByteError>

Read an unsigned big-endian four-byte integer.

pub fn take(&mut self, length: usize) -> Result<&'a [u8], ByteError>

Borrow exactly length bytes.

pub fn sub_reader(&mut self, length: usize) -> Result<ByteReader<'a>, ByteError>

Create a child reader bounded to exactly length bytes and advance the parent.

Trait Implementations

impl<'a> Clone for ByteReader<'a>

fn clone(&self) -> ByteReader<'a>

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<'a> Debug for ByteReader<'a>

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

Formats the value using the given formatter.