Skip to main content

RansEncoder

Struct RansEncoder 

Source
pub struct RansEncoder { /* private fields */ }
Expand description

A symbol-at-a-time rANS encoder.

Feed symbols with put (in reverse message order – this is inherent to rANS), then call finish to obtain the byte stream.

The same byte stream is decodable by RansDecoder or decode.

Implementations§

Source§

impl RansEncoder

Source

pub fn new() -> Self

Create a new encoder with default buffer capacity.

Source

pub fn with_capacity(cap: usize) -> Self

Create a new encoder with pre-allocated buffer capacity.

Source

pub fn put(&mut self, sym: u32, table: &FrequencyTable) -> Result<(), AnsError>

Encode a single symbol into the rANS state.

Symbols must be fed in reverse message order. If the original message is [A, B, C], call put(C), put(B), put(A).

Source

pub fn finish(self) -> Vec<u8>

Finalize the encoder, writing the final state and returning the byte stream.

The returned bytes can be decoded by RansDecoder::new or decode.

Source

pub fn state(&self) -> u32

Current rANS state (for bits-back interleaving).

Trait Implementations§

Source§

impl Clone for RansEncoder

Source§

fn clone(&self) -> RansEncoder

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for RansEncoder

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for RansEncoder

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

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> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. 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> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. 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.