Struct BitWriter 

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

A bounded bit-level writer for encoding packed binary data.

The writer never grows the buffer. Writes past the end return BitError::WriteOverflow.

Implementations

impl<'a> BitWriter<'a>

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

Creates a new BitWriter over a fixed buffer.

pub const fn bits_written(&self) -> usize

Returns the number of bits written so far.

pub const fn bits_remaining(&self) -> usize

Returns the number of bits remaining in the buffer.

pub fn write_bit(&mut self, value: bool) -> BitResult<()>

Writes a single bit.

pub fn write_bits(&mut self, value: u64, bits: u8) -> BitResult<()>

Writes up to 64 bits from an unsigned integer.

Errors

Returns BitError::InvalidBitCount if bits > 64. Returns BitError::ValueOutOfRange if value doesn’t fit in bits.

pub fn align_to_byte(&mut self) -> BitResult<()>

Pads with zero bits until the next byte boundary.

pub fn write_u8_aligned(&mut self, value: u8) -> BitResult<()>

Writes a byte-aligned u8.

pub fn write_u16_aligned(&mut self, value: u16) -> BitResult<()>

Writes a byte-aligned u16 (little-endian).

pub fn write_u32_aligned(&mut self, value: u32) -> BitResult<()>

Writes a byte-aligned u32 (little-endian).

pub fn write_u64_aligned(&mut self, value: u64) -> BitResult<()>

Writes a byte-aligned u64 (little-endian).

pub fn write_varu32(&mut self, value: u32) -> BitResult<()>

Writes a byte-aligned varint u32.

pub fn write_vars32(&mut self, value: i32) -> BitResult<()>

Writes a byte-aligned zigzag varint i32.

pub fn finish(self) -> usize

Finishes writing and returns the number of bytes used.

Trait Implementations

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

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

Formats the value using the given formatter.