Struct Reader

pub struct Reader { /* private fields */ }

Panic-free forward-only cursor. See the module level docs.

Implementations

impl Reader

pub fn new<T: Into<Bytes>>(bytes: T) -> Self

Creates a new Reader from anything that implements Into<Bytes>.

This does not allocate by itself, but the Into<Bytes> implementation might.

pub fn remaining(&self) -> usize

Returns how many bytes have not been read.

pub fn at_least(&self, len: usize) -> bool

Returns true if at least len many bytes are unread.

pub fn consumed(&self) -> usize

Returns how many bytes have been read so far.

pub fn skip(&mut self, amt: usize)

Skips amt bytes.

pub fn peek(&self, val: u8) -> bool

Returns true if there is another byte to read and it is equal to val.

pub fn read_to_end(self) -> Bytes

Returns the rest of the unread data, consuming the iterator.

Special behavior: If there are no bytes left, the inner value will be dropped, instead returning a Bytes pointing to a static, empty slice.

pub fn subreader(&mut self, len: usize) -> Result<Self, EndOfInput>

Returns a Reader that can read the next len bytes, advancing the original cursor by the same amount.

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

Reads a single byte. Identical to read_u8.

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

Returns the next len bytes as a Bytes, advancing the cursor.

pub fn read_slice(&mut self, len: usize) -> Result<&[u8], EndOfInput>

Returns the next len bytes as a slice, advancing the cursor. The returned slice will always be of length len.

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

Returns an array of size N, advancing the cursor.

pub fn read<T: Decode>(&mut self) -> Result<T, EndOfInput>

Attempts to read a value based on its Decode implementation.

Trait Implementations

impl AsMut<Reader> for Reader

fn as_mut(&mut self) -> &mut Reader

Converts this type into a mutable reference of the (usually inferred) input type.

impl From<Bytes> for Reader

fn from(value: Bytes) -> Self

Converts to this type from the input type.