Struct BitstreamWriter 

pub struct BitstreamWriter {
    pub data: Box<[u8]>,
    pub data_size: i32,
    pub data_position: i32,
    pub cache: u32,
    pub cache_bits: i32,
}

Bitstream writer structure (matches shine’s bitstream_t exactly) (ref/shine/src/lib/bitstream.h:4-10)

Fields

data: Box<[u8]>

Processed data

data_size: i32

Total data size

data_position: i32

Data position

cache: u32

Bit stream cache

cache_bits: i32

Free bits in cache

Implementations

impl BitstreamWriter

pub fn new(size: i32) -> Self

Open the bitstream for writing (matches shine_open_bit_stream) (ref/shine/src/lib/bitstream.c:15-22)

pub fn put_bits(&mut self, val: u32, n: i32) -> EncodingResult<()>

Write N bits into the bit stream (matches shine_putbits exactly) (ref/shine/src/lib/bitstream.c:30-58)

Arguments

• val - value to write into the buffer
• n - number of bits of val

pub fn get_bits_count(&self) -> i32

Get the current bit count (matches shine_get_bits_count exactly) (ref/shine/src/lib/bitstream.c:60-62)

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

Get the output data

pub fn flush(&mut self) -> EncodingResult<()>

Flush any remaining bits in the cache This matches shine’s behavior when there are remaining bits in cache

pub fn byte_align(&mut self) -> EncodingResult<()>

Align to byte boundary by flushing partial bytes This matches shine’s byte alignment behavior

Trait Implementations

impl Debug for BitstreamWriter

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

Formats the value using the given formatter.

impl Default for BitstreamWriter

fn default() -> Self

Returns the “default value” for a type.