Struct Decoder

pub struct Decoder { /* private fields */ }

An entropy decoder.

Implementations

impl Decoder

pub fn parse(bitstream: &mut Bitstream<'_>, num_dist: u32) -> Result<Self>

Create a decoder by reading symbol distribution, integer configurations and LZ77 configuration from the bitstream.

pub fn read_varint( &mut self, bitstream: &mut Bitstream<'_>, ctx: u32, ) -> Result<u32>

Read an integer from the bitstream with the given context.

pub fn read_varint_with_multiplier( &mut self, bitstream: &mut Bitstream<'_>, ctx: u32, dist_multiplier: u32, ) -> Result<u32>

Read an integer from the bitstream with the given context and LZ77 distance multiplier.

pub fn read_varint_with_multiplier_clustered( &mut self, bitstream: &mut Bitstream<'_>, cluster: u8, dist_multiplier: u32, ) -> Result<u32>

Read an integer from the bitstream with the given cluster and LZ77 distance multiplier.

Contexts can be converted to clusters using the cluster map.

pub fn as_rle(&mut self) -> Option<DecoderRleMode<'_>>

pub fn as_with_lz77(&mut self) -> Option<DecoderWithLz77<'_>>

pub fn as_no_lz77(&mut self) -> Option<DecoderNoLz77<'_>>

pub fn single_token(&self, cluster: u8) -> Option<u32>

pub fn begin(&mut self, bitstream: &mut Bitstream<'_>) -> Result<()>

Explicitly start reading an entropy encoded stream.

This involves reading an initial state for the ANS stream. It’s okay to skip this method, as the state will be initialized on the first read.

pub fn finalize(&self) -> Result<()>

Finalizes the stream, and check whether the stream was valid.

For prefix code stream, this method will always succeed. For ANS streams, this method checks if the final state matches expected state, which is specified in the specification.

pub fn cluster_map(&self) -> &[u8]

Returns the cluster mapping of distributions.

Trait Implementations

impl Clone for Decoder

fn clone(&self) -> Decoder

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Decoder

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

Formats the value using the given formatter.