Struct BitWriter 

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

Writes fields MSB-first into a borrowed mutable byte slice.

Each bit is explicitly set or cleared, so buf need not be zeroed first.

Implementations

impl<'a> BitWriter<'a>

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

Create a writer positioned at the first bit of data.

pub fn capacity_bits(&self) -> usize

Total bits the backing buffer can hold.

pub fn bits_written(&self) -> usize

Bits written so far.

pub fn is_byte_aligned(&self) -> bool

true if the cursor sits on a byte boundary.

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

Write the low n bits (0..=64) of value, MSB-first.

write_bits(_, 0) writes nothing.

Errors

BitError::TooManyBits if n > 64; BitError::ValueTooWide if value has bits set above bit n-1; BitError::OutOfBounds if the buffer cannot hold n more bits.

pub fn write_bool(&mut self, value: bool) -> Result<(), BitError>

Write a single bit from a bool.

Errors

BitError::OutOfBounds if the buffer is full.

pub fn align_to_byte(&mut self) -> Result<(), BitError>

Pad with zero bits up to the next byte boundary (no-op if aligned).

Errors

BitError::OutOfBounds if the buffer cannot hold the padding.

Trait Implementations

impl<'a> Debug for BitWriter<'a>

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

Formats the value using the given formatter.