Struct BitReadBuffer

pub struct BitReadBuffer<'a, E>
where
    E: Endianness,
{ /* private fields */ }

Buffer that allows reading integers of arbitrary bit length and non byte-aligned integers

Examples

use bitbuffer::{BitReadBuffer, LittleEndian, Result};

let bytes = vec![
    0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
    0b1001_1001, 0b1001_1001, 0b1001_1001, 0b1110_0111
];
let buffer = BitReadBuffer::new(&bytes, LittleEndian);
// read 7 bits as u8, starting from bit 3
let result: u8 = buffer.read_int(3, 7)?;

Implementations

impl<'a, E> BitReadBuffer<'a, E>

where E: Endianness,

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

Create a new BitBuffer from a byte slice

Examples

use bitbuffer::{BitReadBuffer, LittleEndian};

let bytes = vec![
    0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
    0b1001_1001, 0b1001_1001, 0b1001_1001, 0b1110_0111
];
let buffer = BitReadBuffer::new(&bytes, LittleEndian);

pub fn to_owned(&self) -> BitReadBuffer<'static, E>

Create a static version of this buffer

If the current buffer is borrowed, this will copy the data

impl<E> BitReadBuffer<'static, E>

where E: Endianness,

pub fn new_owned(bytes: Vec<u8>, _endianness: E) -> Self

Create a new BitBuffer from a byte vector

Examples

use bitbuffer::{BitReadBuffer, LittleEndian};

let bytes = vec![
    0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
    0b1001_1001, 0b1001_1001, 0b1001_1001, 0b1110_0111
];
let buffer = BitReadBuffer::new_owned(bytes, LittleEndian);

impl<'a, E> BitReadBuffer<'a, E>

where E: Endianness,

pub fn bit_len(&self) -> usize

The available number of bits in the buffer

pub fn byte_len(&self) -> usize

The available number of bytes in the buffer

pub fn read_bool(&self, position: usize) -> Result<bool>

Read a single bit from the buffer as boolean

Errors

• ReadError::NotEnoughData: not enough bits available in the buffer

Examples

let result = buffer.read_bool(5)?;
assert_eq!(result, true);

pub fn read_int<T>(&self, position: usize, count: usize) -> Result<T>

where T: PrimInt + BitOrAssign + IsSigned + UncheckedPrimitiveInt + BitXor + WrappingSub,

Read a sequence of bits from the buffer as integer

Errors

• ReadError::NotEnoughData: not enough bits available in the buffer
• ReadError::TooManyBits: to many bits requested for the chosen integer type

Examples

let result = buffer.read_int::<u16>(10, 9)?;
assert_eq!(result, 0b100_0110_10);

pub fn read_bytes( &self, position: usize, byte_count: usize, ) -> Result<Cow<'a, [u8]>>

Read a series of bytes from the buffer

Errors

• ReadError::NotEnoughData: not enough bits available in the buffer

Examples

assert_eq!(buffer.read_bytes(5, 3)?.to_vec(), &[0b0_1010_101, 0b0_1100_011, 0b1_1001_101]);
assert_eq!(buffer.read_bytes(0, 8)?.to_vec(), &[
    0b1011_0101, 0b0110_1010, 0b1010_1100, 0b1001_1001,
    0b1001_1001, 0b1001_1001, 0b1001_1001, 0b1110_0111
]);

pub fn read_string( &self, position: usize, byte_len: Option<usize>, ) -> Result<Cow<'a, str>>

Read a series of bytes from the buffer as string

You can either read a fixed number of bytes, or a dynamic length null-terminated string

Errors

• ReadError::NotEnoughData: not enough bits available in the buffer
• ReadError::Utf8Error: the read bytes are not valid utf8

Examples

// Fixed length string
assert_eq!(buffer.read_string(0, Some(13))?, "Hello world".to_owned());
// fixed length with null padding
assert_eq!(buffer.read_string(0, Some(16))?, "Hello world".to_owned());
// null terminated
assert_eq!(buffer.read_string(0, None)?, "Hello world".to_owned());

pub fn read_float<T>(&self, position: usize) -> Result<T>

where T: Float + UncheckedPrimitiveFloat,

Read a sequence of bits from the buffer as float

Errors

• ReadError::NotEnoughData: not enough bits available in the buffer

Examples

let result = buffer.read_float::<f32>(10)?;

pub fn truncate(&mut self, bit_len: usize) -> Result<()>

Truncate the buffer to a given bit length

Trait Implementations

impl<E: Endianness> Clone for BitReadBuffer<'_, E>

fn clone(&self) -> Self

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<E: Endianness> Debug for BitReadBuffer<'_, E>

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

Formats the value using the given formatter.

impl<'a, E: Endianness> From<&'a [u8]> for BitReadBuffer<'a, E>

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

Converts to this type from the input type.

impl<'a, E: Endianness> From<BitReadBuffer<'a, E>> for BitReadStream<'a, E>

fn from(buffer: BitReadBuffer<'a, E>) -> Self

Converts to this type from the input type.

impl<E: Endianness> From<Vec<u8>> for BitReadBuffer<'_, E>

fn from(bytes: Vec<u8>) -> Self

Converts to this type from the input type.

impl<E: Endianness> PartialEq for BitReadBuffer<'_, E>

fn eq(&self, other: &Self) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.