Struct x3::bytereader::ByteReader

pub struct ByteReader<'a> { /* fields omitted */ }

BitReader allows individual bits to be read from an array of bytes.

Implementations

impl<'a> ByteReader<'a>

pub fn new(array: &'a [u8]) -> ByteReader<'_>

pub fn reset(&mut self)

pub fn set_pos(&mut self, p_byte: usize)

pub fn get_pos(&self) -> usize

pub fn find_le_u16(&mut self, word: u16) -> bool

pub fn extract(
    &self,
    p_start: usize,
    p_end: usize
) -> Result<Vec<u8>, BitPackError>

pub fn eq(&self, buf: &[u8]) -> bool

Check if buf and ByteReader array at the current read position contain the same information.

Note:

Arguments

• buf - The array where the bytes will be written to.

pub fn remaining_bytes(&self) -> Result<usize, BitPackError>

Get the number of bytes remaining in the ByteReader buffer.

pub fn inc_counter(&mut self, n_bytes: usize) -> Result<(), BitPackError>

This operates together with write_packed_bits. It increments the p_byte value by n_bytes.

pub fn dec_counter(&mut self, n_bytes: usize) -> Result<(), BitPackError>

This operates together with write_packed_bits. It decrements the p_byte value by n_bytes.

pub fn read(&mut self, buf: &mut [u8]) -> Result<usize, BitPackError>

Read buf.len() bytes and write them to buf.

Arguments

• buf - The array where the bytes will be written to.

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

Read the next two bytes as big-endian u16.

pub fn read_be_u16(&mut self) -> Result<u16, BitPackError>

Read the next two bytes as big-endian u16.

pub fn read_be_i16(&mut self) -> Result<i16, BitPackError>

Read the next two bytes as big-endian i16.

pub fn read_le_i16(&mut self) -> Result<i16, BitPackError>

Read the next two bytes as little-endian i16.

pub fn crc16(&self, num_bytes: usize) -> Result<u16, BitPackError>