Struct BitReader 

pub struct BitReader<R: Read, E: Endianness> { /* private fields */ }

Implementations

impl<R: Read, E: Endianness> BitReader<R, E>

pub fn new(reader: R) -> Self

Create a new BitReader wrapping the given reader

pub fn read_bit(&mut self) -> Result<bool>

Reads a single bit from the stream

pub fn read<const BITS: u32, T: Integer>(&mut self) -> Result<T>

Reads up to BITS bits as a value of type T

pub fn read_var<T: Integer>(&mut self, bits: u32) -> Result<T>

Reads bits number of bits as a value of type T

pub fn skip(&mut self, bits: u32) -> Result<()>

Skips the given number of bits

pub fn byte_aligned(&self) -> bool

Returns true if the stream is byte-aligned

pub fn byte_align(&mut self)

Discards any remaining bits until the stream is byte-aligned

pub fn read_bytes(&mut self, buf: &mut [u8]) -> Result<()>

Reads exactly buf.len() bytes into the buffer

pub fn read_to_vec(&mut self, bytes: usize) -> Result<Vec<u8>>

Reads bytes number of bytes into a vector

pub fn read_unary<const STOP_BIT: u8>(&mut self) -> Result<u32>

Reads bits until a stop bit is encountered

impl<R: Read + Seek, E: Endianness> BitReader<R, E>

pub fn bits_left(&mut self) -> Result<usize>

Returns the number of bits left in the stream

impl<'a, E: Endianness> BitReader<Cursor<&'a [u8]>, E>

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

Create a BitReader from a byte slice, automatically tracking length

pub fn remaining_slice(&mut self) -> &'a [u8]

Get the remaining data as a byte-aligned slice

impl<R: Read> BitReader<R, BigEndian>

pub fn read_ue(&mut self) -> Result<u32>

Reads an unsigned Exp-Golomb coded value (ue(v))

pub fn read_se(&mut self) -> Result<i32>

Reads a signed Exp-Golomb coded value (se(v))

impl<R: Read + Seek, E: Endianness> BitReader<R, E>

pub fn position_in_bits(&mut self) -> Result<u64>

Gets the current position in bits from the start of the stream

pub fn seek_bits(&mut self, from: SeekFrom) -> Result<u64>

Seeks to a position in the stream by bits

pub fn peek<const BITS: u32, T: Integer>(&mut self) -> Result<T>

Peeks the next BITS bits without consuming them

pub fn peek_var<T: Integer>(&mut self, bits: u32) -> Result<T>

Peeks bits number of bits without consuming them

pub fn peek_bit(&mut self) -> Result<bool>

Peeks a single bit without consuming it

impl<R: Read + Seek> BitReader<R, BigEndian>

pub fn peek_ue(&mut self) -> Result<u32>

Peeks an unsigned Exp-Golomb coded value without consuming it

pub fn peek_se(&mut self) -> Result<i32>

Peeks a signed Exp-Golomb coded value without consuming it