Struct Bitstream

pub struct Bitstream<'buf> { /* private fields */ }

Bitstream reader with borrowed in-memory buffer.

Implementation is mostly from jxl-rs.

Implementations

impl<'buf> Bitstream<'buf>

pub fn new(bytes: &'buf [u8]) -> Self

Create a new bitstream reader.

pub fn num_read_bits(&self) -> usize

Returns the number of bits that are read or skipped.

impl Bitstream<'_>

pub fn peek_bits(&mut self, n: usize) -> u32

Peeks bits from bitstream, without consuming them.

This method refills the bit buffer.

pub fn peek_bits_const<const N: usize>(&mut self) -> u32

Peeks bits from bitstream, without consuming them.

This method refills the bit buffer.

pub fn peek_bits_prefilled(&mut self, n: usize) -> u32

Peeks bits from already filled bitstream, without consuming them.

This method does not refill the bit buffer.

pub fn peek_bits_prefilled_const<const N: usize>(&mut self) -> u32

Peeks bits from already filled bitstream, without consuming them.

This method does not refill the bit buffer.

pub fn consume_bits(&mut self, n: usize) -> Result<()>

Consumes bits in bit buffer.

Errors

This method returns Err(Io(std::io::ErrorKind::UnexpectedEof)) when there are not enough bits in the bit buffer.

pub fn consume_bits_const<const N: usize>(&mut self) -> Result<()>

Consumes bits in bit buffer.

Errors

This method returns Err(Io(std::io::ErrorKind::UnexpectedEof)) when there are not enough bits in the bit buffer.

pub fn read_bits(&mut self, n: usize) -> Result<u32>

Read and consume bits from bitstream.

pub fn skip_bits(&mut self, n: usize) -> Result<()>

pub fn zero_pad_to_byte(&mut self) -> Result<()>

Performs ZeroPadToByte as defined in the JPEG XL specification.

impl Bitstream<'_>

pub fn read_u32( &mut self, d0: impl Into<U32Specifier>, d1: impl Into<U32Specifier>, d2: impl Into<U32Specifier>, d3: impl Into<U32Specifier>, ) -> Result<u32>

Reads an U32 as defined in the JPEG XL specification.

Example

use jxl_bitstream::{Bitstream, U};

let buf = [0b110010];
let mut bitstream = Bitstream::new(&buf);
let val = bitstream.read_u32(1, U(2), 3 + U(4), 19 + U(8)).expect("failed to read data");
assert_eq!(val, 15);

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

Reads an U64 as defined in the JPEG XL specification.

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

Reads a Bool as defined in the JPEG XL specification.

pub fn read_f16_as_f32(&mut self) -> Result<f32>

Reads an F16 as defined in the JPEG XL specification, and convert it to f32.

Errors

Returns Error::InvalidFloat if the value is NaN or Infinity.

pub fn read_enum<E: TryFrom<u32>>(&mut self) -> Result<E>

Reads an enum as defined in the JPEG XL specification.

Trait Implementations

impl<'buf> Clone for Bitstream<'buf>

fn clone(&self) -> Bitstream<'buf>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Bitstream<'_>

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

Formats the value using the given formatter.