Struct Unpacker 

pub struct Unpacker<B> { /* private fields */ }

Sequentially unpacks values from a buffer.

Each unpack call extracts the lower SIZE bits of the buffer and shifts the remaining bits down, so values are extracted in reverse order of how they were packed.

Most callers will not interact with Unpacker directly — the #[packable] macro generates code that uses it.

Example

use bitcram::Unpacker;

let mut unpacker = Unpacker::<u32>::new(0b1011);
assert_eq!(unpacker.raw_unpack(1), 0b1);
assert_eq!(unpacker.raw_unpack(3), 0b101);

Implementations

impl<B: Buffer> Unpacker<B>

pub fn new(buffer: B) -> Self

Creates a new unpacker over buffer.

pub fn unpack<P: Packable<B>>(&mut self) -> P

Extracts a value from the buffer using its Packable implementation.

pub fn raw_unpack(&mut self, size: u32) -> B

Extracts the lower size bits of the buffer and advances past them.

size must satisfy size < B::BITS. Reading exactly B::BITS of data requires multiple calls each smaller than B::BITS.

pub fn into_inner(self) -> B

Consumes the unpacker and returns the remaining buffer state.

Trait Implementations

impl<B: Debug> Debug for Unpacker<B>

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

Formats the value using the given formatter.