Struct BitWriter 

pub struct BitWriter { /* private fields */ }

A most-significant-bit-first bit writer.

AV1 uncompressed headers and OBU framing are described with f(n) fixed-width fields that a decoder reads most-significant-bit first (AV1 §8.1, “Parsing process for f(n)”); this writer is the encoder-side mirror. Bits accumulate into an internal byte buffer; the buffer is byte aligned exactly when BitWriter::is_byte_aligned returns true.

Implementations

impl BitWriter

pub fn new() -> Self

Creates an empty writer.

pub fn put_bit(&mut self, bit: u8)

Writes a single bit (f(1)); only the low bit of bit is used.

pub fn put_bits(&mut self, value: u32, n: u32)

Writes the low n bits of value, most-significant bit first (f(n)). n must be 0..=32.

pub fn bit_len(&self) -> usize

Number of bits written so far.

pub fn is_byte_aligned(&self) -> bool

Returns true when the next bit would start a fresh byte.

pub fn byte_align(&mut self)

Pads with zero bits up to the next byte boundary (a no-op when already aligned).

pub fn put_bytes(&mut self, data: &[u8])

Appends whole bytes verbatim. Requires the writer to be byte aligned.

Panics

Debug builds assert byte alignment; misuse in release silently misaligns the stream.

pub fn as_bytes(&self) -> &[u8]

Borrows the bytes written so far.

pub fn into_bytes(self) -> Vec<u8>

Consumes the writer, returning the byte buffer (trailing bits in the final partial byte are zero-filled).

Trait Implementations

impl Clone for BitWriter

fn clone(&self) -> BitWriter

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for BitWriter

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

Formats the value using the given formatter.

impl Default for BitWriter

fn default() -> BitWriter

Returns the “default value” for a type.