Struct bdk_chain::bitcoin::bip158::BitStreamReader

pub struct BitStreamReader<'a, R>
where
    R: ?Sized,
{ /* private fields */ }

Bitwise stream reader.

Implementations

impl<'a, R> BitStreamReader<'a, R>

where R: Read + ?Sized,

pub fn new(reader: &'a mut R) -> BitStreamReader<'a, R>

Creates a new BitStreamReader that reads bitwise from a given reader.

pub fn read(&mut self, nbits: u8) -> Result<u64, Error>

Reads nbit bits, returning the bits in a u64 starting with the rightmost bit.

Examples

let mut reader = BitStreamReader::new(&mut input); // input contains all 1's
let res = reader.read(1).expect("read failed");
assert_eq!(res, 1_u64);