Struct BitReader 

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

Reads packed bits from a borrowed byte slice, most-significant-bit first.

Example

use wire_codec::BitReader;

// 0b1010_1100 = 0xAC. Read 3 bits, then 5 bits.
let mut r = BitReader::new(&[0xAC]);
assert_eq!(r.read_bits(3).unwrap(), 0b101);
assert_eq!(r.read_bits(5).unwrap(), 0b01100);

Implementations

impl<'a> BitReader<'a>

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

Wrap bytes in a new bit cursor positioned at the first bit.

pub const fn bits_consumed(&self) -> usize

Number of bits already consumed.

pub const fn bits_remaining(&self) -> usize

Number of bits still available to read.

pub fn align_to_byte(&mut self)

Advance the cursor to the next byte boundary.

pub fn read_bits(&mut self, n: u32) -> Result<u64>

Read the next n bits as the low-order bits of a u64.

Errors

• Error::BitOverflow if n is 0 or greater than MAX_BIT_WIDTH.
• Error::UnexpectedEof if fewer than n bits remain in the input.

Trait Implementations

impl<'a> Clone for BitReader<'a>

fn clone(&self) -> BitReader<'a>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for BitReader<'a>

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

Formats the value using the given formatter.