Struct BitWriter 

pub struct BitWriter<'a, W: Writer> { /* private fields */ }

A wrapper around a Writer that allows writing data bit-by-bit.

Implementations

impl<'a, W: Writer> BitWriter<'a, W>

pub const fn new(writer: &'a mut W) -> Self

Creates a new BitWriter.

pub const fn from_state( writer: &'a mut W, current_byte: u8, bit_count: u8, ) -> Self

Creates a new BitWriter with an existing state.

pub const fn get_state(&self) -> (u8, u8)

Returns the current state of the bit writer (current_byte, bit_count).

pub fn write_bits_lsb( &mut self, val: u64, num_bits: u8, ) -> Result<(), EncodeError>

Writes num_bits from val into the stream, using LSB-first bit ordering.

Errors

Returns EncodeError if the underlying writer fails to write the data.

pub fn write_bits_msb( &mut self, val: u64, num_bits: u8, ) -> Result<(), EncodeError>

Writes num_bits from val into the stream, using MSB-first bit ordering.

Errors

Returns EncodeError if the underlying writer fails to write the data.

pub fn write_bits<C: Config>( &mut self, val: u64, num_bits: u8, config: &C, ) -> Result<(), EncodeError>

Writes num_bits from val into the stream, using the bit ordering from the configuration.

Errors

Returns EncodeError if the underlying writer fails to write the data.

pub fn flush(&mut self) -> Result<(), EncodeError>

Flushes any remaining bits to the underlying writer, padding with 0s.

Errors

Returns EncodeError if the underlying writer fails to write the data.