Struct Reader 

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

Reads little-endian integers and CompactSize-prefixed fields from a byte slice. Every read is bounds-checked.

Implementations

impl<'a> Reader<'a>

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

A reader positioned at the start of bytes.

pub const fn position(&self) -> usize

Current offset.

pub fn remaining(&self) -> usize

Bytes not read yet.

pub fn is_done(&self) -> bool

True once every byte has been read.

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

The unread bytes (without consuming them).

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

The next n bytes.

pub fn array<const N: usize>(&mut self) -> Result<[u8; N], EncodingError>

The next N bytes as an array.

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

One byte.

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

2-byte little-endian unsigned integer.

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

4-byte little-endian unsigned integer.

pub fn i64(&mut self) -> Result<i64, EncodingError>

8-byte little-endian signed integer.

pub fn compact_size(&mut self) -> Result<u64, EncodingError>

A minimally encoded CompactSize of at most MAX_COMPACT_SIZE.

pub fn count(&mut self, min_item_size: usize) -> Result<usize, EncodingError>

A CompactSize used as a length or count, checked against the bytes left (each item at least min_item_size bytes), so a hostile count can’t trigger a huge allocation.

pub fn var_bytes(&mut self) -> Result<&'a [u8], EncodingError>

A CompactSize-prefixed byte string.

Trait Implementations

impl<'a> Clone for Reader<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Reader<'_>

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

Formats the value using the given formatter.