Struct BitStreamReader 

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

Implementations

impl<'a> BitStreamReader<'a>

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

Create a new LSB-first reader

Properties

• buffer: The buffer to read from

pub fn slice(&self, from_start: bool) -> &[u8]

Return slice from reading position (or start, if from_start is true) to offset-end

pub fn set_marker(&mut self)

Set marker at current byte

pub fn reset_marker(&mut self)

Unset marker

pub fn slice_marker(&self, to: Option<usize>) -> &[u8]

Return slice from marker (or start if marker is unset) to specific position or current byte If crypto is set, it will return the decrypted slice. This is different from other slice methods which always returns the raw buffer slice.

pub fn slice_end(&mut self) -> &[u8]

Return slice from offset-end to end of buffer If crypto is set, it will apply the keystream to the slice before returning. This is different from other slice methods which always returns the raw buffer slice.

pub fn slice_start(&self) -> &[u8]

Return slice from start of buffer to current byte position

pub fn set_crypto(&mut self, crypto: Option<Box<dyn CryptoStream>>)

Set crypto stream

pub fn reset_crypto(&mut self)

Remove crypto stream

pub fn set_offset_end(&mut self, len: usize)

Set integrity offset to ignore when reading

pub fn byte_pos(&self) -> usize

Get byte position of reader

pub fn read_bit(&mut self) -> Result<bool, DeserializationError>

Read a single bit

pub fn read_small(&mut self, bits: u8) -> Result<u8, DeserializationError>

Read 1-8 bits as u8 (LSB-first)

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

Read a full byte, aligning to the next byte boundary

pub fn read_bytes( &mut self, count: usize, ) -> Result<&[u8], DeserializationError>

Read a slice of bytes, aligning first

pub fn read_dyn_int(&mut self) -> Result<u128, DeserializationError>

Read a dynamic int, starting at the next byte bounary The last bit is used as a continuation flag for the next byte

pub fn read_fixed_int<const S: usize, T: FixedInt<S>>( &mut self, ) -> Result<T, DeserializationError>

Read a integer of fixed size from the buffer

pub fn align_byte(&mut self)

Align the reader to the next byte boundary

pub fn bytes_left(&self) -> usize

Get bytes left

pub fn reset(&mut self)

Reset reading position