Skip to main content

RansEncoderStream

Struct RansEncoderStream 

Source
pub struct RansEncoderStream<S: EncoderVariantForS> { /* private fields */ }
Expand description

rANS encoder stream for a specific variant S.

Keeps a persistent raw encoder state across push() calls. flush() writes the final state and yields the encoded message; the stream can then be reused. reset() aborts the current session.

Implementations§

Source§

impl<S: EncoderVariantForS> RansEncoderStream<S>

Source

pub fn new() -> Self

Create a new encoder stream.

Source

pub fn is_initialized(&self) -> bool

Whether the stream has an active encoder session.

Source

pub fn push( &mut self, encoder: &EntropyEncoder<S>, indices: &[i32], values: &[i32], ) -> Result<(), EntropyError>

Push an entropy-encoded batch onto the stream.

Encodes values using the given encoder’s PMF, continuing the persistent raw encoder state. Matches EntropyEncoder::push in Python and IEntropyEncoderImpl::Encode(stream, indices, values).

Source

pub fn flush(&mut self) -> Result<Vec<u8>, EntropyError>

Flush the current session and return the encoded message.

After flush, the stream is reset for reuse. Returns an error if no data has been pushed (matching the Python flush which raises on empty output).

Source

pub fn reset(&mut self)

Abort the current session, discarding all pushed data.

Trait Implementations§

Source§

impl<S: Debug + EncoderVariantForS> Debug for RansEncoderStream<S>
where S::RawEnc: Debug,

Source§

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

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

impl<S: EncoderVariantForS> Default for RansEncoderStream<S>

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> 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.