Struct Bitstream

pub struct Bitstream<R: ReadBytes> { /* private fields */ }

Wraps a Reader to facilitate reading that is not byte-aligned.

Implementations

impl<R: ReadBytes> Bitstream<R>

pub fn new(reader: R) -> Bitstream<R>

Wraps the reader with a reader that facilitates reading individual bits.

pub fn read_bit(&mut self) -> Result<bool>

Reads a single bit.

Reading a single bit can be done more efficiently than reading more than one bit, because a bit never straddles a byte boundary.

pub fn read_unary(&mut self) -> Result<u32>

Reads bits until a 1 is read, and returns the number of zeros read.

Because the reader buffers a byte internally, reading unary can be done more efficiently than by just reading bit by bit.

pub fn read_leq_u8(&mut self, bits: u32) -> Result<u8>

Reads at most eight bits.

pub fn read_gt_u8_leq_u16(&mut self, bits: u32) -> Result<u32>

Read n bits, where 8 < n <= 16.

pub fn read_leq_u16(&mut self, bits: u32) -> Result<u16>

Reads at most 16 bits.

pub fn read_leq_u32(&mut self, bits: u32) -> Result<u32>

Reads at most 32 bits.