Skip to main content

BitReader

Struct BitReader 

Source
pub struct BitReader<'a> { /* private fields */ }
Expand description

Bit-level reader for parsing JPEG-XL bitstreams.

Reads bits from a byte buffer in LSB-first order, which is the convention used by JPEG-XL codestreams (and ANS entropy coding).

Implementations§

Source§

impl<'a> BitReader<'a>

Source

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

Create a new bit reader over a byte slice.

Source

pub fn read_bits(&mut self, n: u8) -> CodecResult<u32>

Read up to 32 bits from the stream (LSB first).

§Errors

Returns CodecError::InvalidBitstream if not enough bits remain.

Source

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

Read a single boolean bit.

Source

pub fn read_u8(&mut self, n: u8) -> CodecResult<u8>

Read up to 8 bits as a u8.

Source

pub fn read_u16(&mut self, n: u8) -> CodecResult<u16>

Read up to 16 bits as a u16.

Source

pub fn read_u32(&mut self, n: u8) -> CodecResult<u32>

Read up to 32 bits as a u32.

Source

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

Read a u64 value using JPEG-XL’s U64 encoding.

The JXL U64 encoding uses a selector to determine how many bits follow:

  • 0: value = 0
  • 1: value = 1 + read(4)
  • 2: value = 17 + read(8)
  • 3: value = read(12) + (read variable chunks until done)
Source

pub fn remaining_bits(&self) -> usize

Number of bits remaining in the stream.

Source

pub fn align_to_byte(&mut self)

Align the reader to the next byte boundary.

If already at a byte boundary, this is a no-op.

Source

pub fn byte_position(&self) -> usize

Get current byte position.

Source

pub fn is_empty(&self) -> bool

Check if the reader has been exhausted.

Auto Trait Implementations§

§

impl<'a> Freeze for BitReader<'a>

§

impl<'a> RefUnwindSafe for BitReader<'a>

§

impl<'a> Send for BitReader<'a>

§

impl<'a> Sync for BitReader<'a>

§

impl<'a> Unpin for BitReader<'a>

§

impl<'a> UnsafeUnpin for BitReader<'a>

§

impl<'a> UnwindSafe for BitReader<'a>

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> IntoEither for T

Source§

fn into_either(self, into_left: bool) -> Either<Self, Self>

Converts self into a Left variant of Either<Self, Self> if into_left is true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

fn into_either_with<F>(self, into_left: F) -> Either<Self, Self>
where F: FnOnce(&Self) -> bool,

Converts self into a Left variant of Either<Self, Self> if into_left(&self) returns true. Converts self into a Right variant of Either<Self, Self> otherwise. Read more
Source§

impl<T> Pointable for T

Source§

const ALIGN: usize

The alignment of pointer.
Source§

type Init = T

The type for initializers.
Source§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
Source§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
Source§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
Source§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.