Skip to main content

EntropyConfig

Struct EntropyConfig 

Source
pub struct EntropyConfig { /* private fields */ }
Available on crate feature entropy only.
Expand description

rANS entropy profile wrapping a Config.

Byte limits cover both frames and decoded storage; collection limits cover symbol counts. Parser depth, token and read-work policies do not apply. This profile adds framed, deterministic static-model coding. The frame magic is RBAN. Verification is hash-free: the decoder re-encodes the decoded symbols and requires the frame to be canonical (see the module docs), with replay verification on by default.

Implementations§

Source§

impl EntropyConfig

Source

pub const fn base_config(self) -> Config

Returns the underlying resource profile.

Source

pub const fn without_replay_verification(self) -> Self

Disables replay verification.

State and consumption checks remain. Neither setting authenticates the decoded data or guarantees detection of substitutions.

Source

pub const fn replay_verification(self) -> bool

Whether replay verification is enabled.

Source

pub const fn without_raw_fallback(self) -> Self

Disables the raw (uncompressed) fallback in Self::compress.

Forces coded frames even for incompressible input. This can increase output size; it adds no authentication or quantified corruption detection.

Source

pub const fn raw_fallback(self) -> bool

Whether the raw (uncompressed) fallback is enabled.

Source

pub fn encode_sequence( &self, models: &[&Model], symbols: &[u32], ) -> Result<Vec<u8>>

Encodes a sequence of symbols, each with its own model, into one frame.

models and symbols must have the same length. Every symbol is coded with the matching model, so the decoder must replay the same model slice in the same order.

Source

pub fn decode_sequence( &self, models: &[&Model], input: &[u8], ) -> Result<Vec<u32>>

Decodes a sequence coded by Self::encode_sequence.

models must match the encoder’s model slice exactly. When replay verification is enabled, the frame is accepted only if re-encoding the decoded symbols reproduces the stored payload and final state.

Source

pub fn compress(&self, input: &[u8], model: &Model) -> Result<Vec<u8>>

Entropy-codes a byte buffer with one model, choosing raw storage when the coded form is not smaller.

Source

pub fn decompress(&self, input: &[u8], model: &Model) -> Result<Vec<u8>>

Decompresses a frame produced by Self::compress.

Trait Implementations§

Source§

impl Clone for EntropyConfig

Source§

fn clone(&self) -> Self

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for EntropyConfig

Source§

impl Debug for EntropyConfig

Source§

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

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

impl Eq for EntropyConfig

Source§

impl PartialEq for EntropyConfig

Source§

fn eq(&self, other: &Self) -> bool

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for EntropyConfig

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 = !

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

fn try_from(value: U) -> Result<T, !>

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.