Skip to main content

BitBufferRead

Struct BitBufferRead 

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

Bit-level reader with JPEG 2000 0xFF byte-unstuffing.

Reads from a byte slice, automatically handling the rule that after a 0xFF byte the MSB of the next byte is ignored (stuffed).

Implementations§

Source§

impl<'a> BitBufferRead<'a>

Source

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

Create a new bit reader over the given byte slice.

Source

pub fn fill(&mut self)

Fill the internal buffer with up to 32 new bits from the byte stream.

Source

pub fn peek(&self, n: u32) -> u32

Peek at the top n bits without consuming them (n <= 32).

Source

pub fn advance(&mut self, n: u32)

Consume n bits from the buffer.

Source

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

Read n bits and return them as a u32 (n <= 32).

Source

pub fn available_bits(&self) -> u32

Returns the number of valid bits currently in the buffer.

Source

pub fn position(&self) -> usize

Returns the current byte position in the data stream.

Source

pub fn is_unstuffing(&self) -> bool

Returns true if the previous byte read was 0xFF.

Source

pub fn reset(&mut self, data: &'a [u8])

Reset the reader with new data.

Trait Implementations§

Source§

impl<'a> Debug for BitBufferRead<'a>

Source§

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

Formats the value using the given formatter. Read more

Auto Trait Implementations§

§

impl<'a> Freeze for BitBufferRead<'a>

§

impl<'a> RefUnwindSafe for BitBufferRead<'a>

§

impl<'a> Send for BitBufferRead<'a>

§

impl<'a> Sync for BitBufferRead<'a>

§

impl<'a> Unpin for BitBufferRead<'a>

§

impl<'a> UnsafeUnpin for BitBufferRead<'a>

§

impl<'a> UnwindSafe for BitBufferRead<'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, 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.