Struct rubble::bytes::ByteReader

pub struct ByteReader<'a>(&'a [u8]);

Allows reading values from a borrowed byte slice.

Tuple Fields

0: &'a [u8]

Implementations

impl<'a> ByteReader<'a>

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

Creates a new ByteReader that will read from the given byte slice.

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

Returns a reference to the raw bytes in self, without advancing self or reading any data.

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

Consumes self and returns the part of the contained buffer that has not yet been read from.

pub fn skip(&mut self, bytes: usize) -> Result<(), Error>

Skips the given number of bytes in the input data without inspecting them.

This is a potentially dangerous operation that should only be used when the bytes really do not matter.

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

Creates and returns another ByteReader that will read from the next len Bytes in the buffer.

self will be modified to point after the split-off bytes, and will continue reading from there.

Note that if the created ByteReader is not used, the bytes will be ignored. If you are really sure you want that, skip is a more explicit way of accomplishing that.

pub fn bytes_left(&self) -> usize

Returns the number of bytes that can still be read from self.

pub fn is_empty(&self) -> bool

Returns whether self is at the end of the underlying buffer (EOF).

If this returns true, no data can be read from self anymore.

pub fn read_obj<T: FromBytes + Unaligned>(&mut self) -> Result<&'a T, Error>

Reads a zerocopy-supported object from the stream by transmuting an appropriate number of bytes.

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

Reads a byte slice of length len from self.

If self contains less than len bytes, Error::Eof will be returned and self will not be modified.

pub fn read_array<S>(&mut self) -> Result<S, Error> where
    S: Default + AsMut<[u8]>, 

Reads a byte-array-like type S from self.

S must implement Default and AsMut<[u8]>, which allows using small arrays up to 32 bytes as well as datastructures from alloc (eg. Box<[u8]> or Vec<u8>).

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

Reads the remaining bytes from self.

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

Reads a single byte from self.

Returns Error::Eof when self is empty.

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

Reads a u16 from self, using Little Endian byte order.

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

Reads a u32 from self, using Little Endian byte order.

pub fn read_u64_le(&mut self) -> Result<u64, Error>

Reads a u64 from self, using Little Endian byte order.