Struct ByteReader

pub struct ByteReader<R: AsyncRead + Unpin + Send + Sync, 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: AsyncRead + Unpin + Send + Sync, 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: AsyncRead + Unpin + Send + Sync, E: Endianness> ByteRead for ByteReader<R, E>

fn read<'life0, 'async_trait, N>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<N, Error>> + Send + 'async_trait>>

where N: 'async_trait + Numeric, Self: 'async_trait, 'life0: 'async_trait,

Reads whole numeric value from stream

fn read_bytes<'life0, 'life1, 'async_trait>( &'life0 mut self, buf: &'life1 mut [u8], ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait, 'life1: 'async_trait,

Completely fills the given buffer with whole bytes.

fn skip<'life0, 'async_trait>( &'life0 mut self, bytes: u32, ) -> Pin<Box<dyn Future<Output = Result<()>> + Send + 'async_trait>>

where Self: 'async_trait, 'life0: 'async_trait,

Skips the given number of bytes in the stream.

fn read_to_bytes<'life0, 'async_trait, const SIZE: usize>( &'life0 mut self, ) -> Pin<Box<dyn Future<Output = Result<[u8; SIZE]>> + Send + 'async_trait>>

where Self: Send + 'async_trait, 'life0: 'async_trait,

Completely fills a whole buffer with bytes and returns it.

fn read_to_vec<'life0, 'async_trait>( &'life0 mut self, bytes: usize, ) -> Pin<Box<dyn Future<Output = Result<Vec<u8>>> + Send + 'async_trait>>

where Self: Send + 'async_trait, 'life0: 'async_trait,

Completely fills a vector of bytes and returns it.