Struct BitStreamReader

pub struct BitStreamReader<'src> {
    pub src: &'src [u8],
    pub position: usize,
    pub bits_left: u8,
    pub buffer: u64,
    pub over_read: usize,
}

Fields

src: &'src [u8]

position: usize

bits_left: u8

buffer: u64

over_read: usize

Implementations

impl<'src> BitStreamReader<'src>

pub fn new(in_buffer: &'src [u8]) -> BitStreamReader<'src>

Create a new BitStreamReader instance

Expectations

The buffer must be padded with fill bytes in the end, if not, this becomes UB in the refill phase.

pub fn refill(&mut self)

Refill the bitstream ensuring the buffer has bits between 56 and 63.

pub fn refill_inner_loop(&mut self)

fn refill_slow(&mut self)

pub fn peek_bits<const LOOKAHEAD: usize>(&self) -> usize

pub fn peek_var_bits(&self, lookahead: usize) -> usize

pub fn get_bits(&mut self, num_bits: u8) -> u64

pub const fn get_bits_left(&self) -> u8

Get number of bits left in the bit buffer.

pub fn get_position(&self) -> usize

Get position the stream is in this buffer Or alternatively, number of bits read.

pub fn reset(&mut self)

Reset buffer and bits left to zero.

pub const fn has(&self, bits: u8) -> bool

Return true if the bit buffer can satisfy bits read without refilling,

pub fn drop_bits(&mut self, bits: u8)

pub const fn remaining_bytes(&self) -> usize

Return the remaining bytes in this stream.

This does not consider bits in the bit-buffer hence may not be accurate