Struct arithmetic_coding::Decoder

source · [−]

pub struct Decoder<M, R> where
    M: Model,
    R: BitRead,  { /* private fields */ }

Expand description

An arithmetic decoder

An arithmetic decoder converts a stream of bytes into a stream of some output symbol, using a predictive Model.

Implementations

source

impl<M, R> Decoder<M, R> where
M: Model,
R: BitRead,

source

pub fn new(model: M, input: R) -> Self

Construct a new Decoder

The ‘precision’ of the encoder is maximised, based on the number of bits needed to represent the Model::denominator. ‘precision’ bits is equal to u32::BITS - Model::denominator bits.

Panics

The calculation of the number of bits used for ‘precision’ is subject to the following constraints:

The total available bits is u32::BITS
The precision must use at least 2 more bits than that needed to represent Model::denominator

If these constraints cannot be satisfied this method will panic in debug builds

source

pub fn with_precision(model: M, input: R, precision: u32) -> Self

Construct a new Decoder with a custom precision

Panics

The calculation of the number of bits used for ‘precision’ is subject to the following constraints:

The total available bits is BitStore::BITS
The precision must use at least 2 more bits than that needed to represent Model::denominator

If these constraints cannot be satisfied this method will panic in debug builds

source

pub fn decode_all(&mut self) -> DecodeIter<'_, M, R>

Return an iterator over the decoded symbols.

The iterator will continue returning symbols until EOF is reached

source

pub fn decode(&mut self) -> Result<Option<M::Symbol>>

Read the next symbol from the stream of bits

This method will return Ok(None) when EOF is reached.

Errors

This method can fail if the underlying BitRead cannot be read from.

source

pub fn chain<X>(self, model: X) -> Decoder<X, R> where
X: Model,

Reuse the internal state of the Decoder with a new model.

Allows for chaining multiple sequences of symbols from a single stream of bits

Trait Implementations

source

impl<M: Debug, R: Debug> Debug for Decoder<M, R> where
 M: Model,
 R: BitRead,
 M::B: Debug,
 M::B: Debug,
 M::B: Debug,

source

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

Formats the value using the given formatter. Read more

Auto Trait Implementations

impl<M, R> RefUnwindSafe for Decoder<M, R> where
 M: RefUnwindSafe,
 R: RefUnwindSafe,
 <M as Model>::B: RefUnwindSafe,

impl<M, R> Send for Decoder<M, R> where
 M: Send,
 R: Send,
 <M as Model>::B: Send,

impl<M, R> Sync for Decoder<M, R> where
 M: Sync,
 R: Sync,
 <M as Model>::B: Sync,

impl<M, R> Unpin for Decoder<M, R> where
 M: Unpin,
 R: Unpin,
 <M as Model>::B: Unpin,

impl<M, R> UnwindSafe for Decoder<M, R> where
 M: UnwindSafe,
 R: UnwindSafe,
 <M as Model>::B: UnwindSafe,

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,

const: unstable · source

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more

source

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

const: unstable · source

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

Mutably borrows from an owned value. Read more

source

impl<T> From<T> for T

const: unstable · source

fn from(t: T) -> T

Returns the argument unchanged.

source

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

const: unstable · 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 for T where
U: Into<T>,

type Error = Infallible

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

source

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

type Error = >::Error

The type returned in the event of a conversion error.

const: unstable · source

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

Performs the conversion.

Struct arithmetic_coding::Decoder

Implementations

impl<M, R> Decoder<M, R> where
M: Model,
R: BitRead,

pub fn new(model: M, input: R) -> Self

Panics

pub fn with_precision(model: M, input: R, precision: u32) -> Self

Panics

pub fn decode_all(&mut self) -> DecodeIter<'_, M, R>

pub fn decode(&mut self) -> Result<Option<M::Symbol>>

Errors

pub fn chain<X>(self, model: X) -> Decoder<X, R> where
X: Model<B = M::B>,

Trait Implementations

impl<M: Debug, R: Debug> Debug for Decoder<M, R> where
    M: Model,
    R: BitRead,
    M::B: Debug,
    M::B: Debug,
    M::B: Debug,

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

Auto Trait Implementations

impl<M, R> RefUnwindSafe for Decoder<M, R> where
    M: RefUnwindSafe,
    R: RefUnwindSafe,
    <M as Model>::B: RefUnwindSafe,

impl<M, R> Send for Decoder<M, R> where
    M: Send,
    R: Send,
    <M as Model>::B: Send,

impl<M, R> Sync for Decoder<M, R> where
    M: Sync,
    R: Sync,
    <M as Model>::B: Sync,

impl<M, R> Unpin for Decoder<M, R> where
    M: Unpin,
    R: Unpin,
    <M as Model>::B: Unpin,

impl<M, R> UnwindSafe for Decoder<M, R> where
    M: UnwindSafe,
    R: UnwindSafe,
    <M as Model>::B: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

Struct arithmetic_coding::Decoder

Implementations

impl<M, R> Decoder<M, R> where M: Model, R: BitRead,

pub fn new(model: M, input: R) -> Self

pub fn with_precision(model: M, input: R, precision: u32) -> Self

pub fn decode_all(&mut self) -> DecodeIter<'_, M, R>

pub fn decode(&mut self) -> Result<Option<M::Symbol>>

pub fn chain<X>(self, model: X) -> Decoder<X, R> where X: Model<B = M::B>,

Trait Implementations

impl<M: Debug, R: Debug> Debug for Decoder<M, R> where M: Model, R: BitRead, M::B: Debug, M::B: Debug, M::B: Debug,

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

Auto Trait Implementations

impl<M, R> RefUnwindSafe for Decoder<M, R> where M: RefUnwindSafe, R: RefUnwindSafe, <M as Model>::B: RefUnwindSafe,

impl<M, R> Send for Decoder<M, R> where M: Send, R: Send, <M as Model>::B: Send,

impl<M, R> Sync for Decoder<M, R> where M: Sync, R: Sync, <M as Model>::B: Sync,

impl<M, R> Unpin for Decoder<M, R> where M: Unpin, R: Unpin, <M as Model>::B: Unpin,

impl<M, R> UnwindSafe for Decoder<M, R> where M: UnwindSafe, R: UnwindSafe, <M as Model>::B: UnwindSafe,

Blanket Implementations

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

fn type_id(&self) -> TypeId

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

fn borrow(&self) -> &T

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

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

impl<T> From<T> for T

fn from(t: T) -> T

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

fn into(self) -> U

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

type Error = Infallible

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

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

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

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

impl<M, R> Decoder<M, R> where
M: Model,
R: BitRead,

pub fn chain<X>(self, model: X) -> Decoder<X, R> where
X: Model<B = M::B>,

impl<M: Debug, R: Debug> Debug for Decoder<M, R> where
M: Model,
R: BitRead,
M::B: Debug,
M::B: Debug,
M::B: Debug,

impl<M, R> RefUnwindSafe for Decoder<M, R> where
M: RefUnwindSafe,
R: RefUnwindSafe,
<M as Model>::B: RefUnwindSafe,

impl<M, R> Send for Decoder<M, R> where
M: Send,
R: Send,
<M as Model>::B: Send,

impl<M, R> Sync for Decoder<M, R> where
M: Sync,
R: Sync,
<M as Model>::B: Sync,

impl<M, R> Unpin for Decoder<M, R> where
M: Unpin,
R: Unpin,
<M as Model>::B: Unpin,

impl<M, R> UnwindSafe for Decoder<M, R> where
M: UnwindSafe,
R: UnwindSafe,
<M as Model>::B: UnwindSafe,

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

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

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

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

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

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