Struct ByteReader

pub struct ByteReader<R: Read, E: Endianness> { /* private fields */ }

For reading aligned bytes from a stream of bytes in a given endianness.

This only reads aligned values and maintains no internal state.

Implementations

impl<R: Read, E: Endianness> ByteReader<R, E>

pub fn new(reader: R) -> ByteReader<R, E>

Wraps a ByteReader around something that implements Read

pub fn endian(reader: R, _endian: E) -> ByteReader<R, E>

Wraps a ByteReader around something that implements Read with the given endianness.

pub fn into_reader(self) -> R

Unwraps internal reader and disposes of ByteReader.

pub fn reader(&mut self) -> &mut R

Provides mutable reference to internal reader

pub fn into_bitreader(self) -> BitReader<R, E>

Converts ByteReader to BitReader in the same endianness.

pub fn bitreader(&mut self) -> BitReader<&mut R, E>

Provides temporary BitReader in the same endianness.

Warning

Any unread bits left over when BitReader is dropped are lost.

Trait Implementations

impl<R: Read, E: Endianness> ByteRead for ByteReader<R, E>

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

where V: Primitive,

Reads whole numeric value from stream

fn read_as<F, V>(&mut self) -> Result<V, Error>

where F: Endianness, V: Primitive,

Reads whole numeric value from stream in a potentially different endianness

fn read_bytes(&mut self, buf: &mut [u8]) -> Result<()>

Completely fills the given buffer with whole bytes.

fn skip(&mut self, bytes: u32) -> Result<()>

Skips the given number of bytes in the stream.

fn reader_ref(&mut self) -> &mut dyn Read

Returns mutable reference to underlying reader

fn read_to_bytes<const SIZE: usize>(&mut self) -> Result<[u8; SIZE]>

👎Deprecated since 1.8.0: use read() method instead

Completely fills a whole buffer with bytes and returns it.

fn read_to_vec(&mut self, bytes: usize) -> Result<Vec<u8>>

Completely fills a vector of bytes and returns it.

fn parse<F: FromByteStream>(&mut self) -> Result<F, F::Error>

Parses and returns complex type

fn parse_with<'a, F: FromByteStreamWith<'a>>( &mut self, context: &F::Context, ) -> Result<F, F::Error>

Parses and returns complex type with context

impl<R: Debug + Read, E: Debug + Endianness> Debug for ByteReader<R, E>

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

Formats the value using the given formatter.