Struct BitReader 

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

Reads bit-level fields from a byte slice, never panicking.

All methods bound-check and return crate::Error::Truncated instead of panicking or wrapping, so hostile input surfaces as an error at the read that needed it.

Implementations

impl<'a> BitReader<'a>

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

Creates a reader over data, positioned at bit 0.

pub const fn remaining_bits(&self) -> usize

The number of bits still readable.

pub const fn bit_position(&self) -> usize

The current bit position from the start of the stream.

pub const fn is_aligned(&self) -> bool

true when the position is on a byte boundary.

pub fn byte_align(&mut self)

Discards bits up to the next byte boundary. Aligned readers are unchanged.

pub fn bits(&mut self, n: usize) -> Result<u64>

Reads n bits with the first stream bit becoming the most-significant bit of the result, for n in 0..=64.

use pith_digest::BitReader;

let mut r = BitReader::new(&[0b1010_0110]);
assert_eq!(r.bits(3).unwrap(), 0b101);
assert_eq!(r.bits(5).unwrap(), 0b0_0110);

pub fn byte(&mut self) -> Result<u8>

Reads one whole byte at the current (must be aligned) position.

Trait Implementations

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

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

Formats the value using the given formatter.