Enum constriction::stream::queue::EncoderSituation

pub enum EncoderSituation<Word> {
    Normal,
    Inverted(NonZeroUsize, Word),
}

Keeps track of yet-to-be-finalized compressed words during encoding with a RangeEncoder.

This type is mostly for internal use. It is only expsed via RangeEncoder::into_raw_parts and RangeEncoder::from_raw_parts.

Variants

Normal

In the Normal situation, all full Words of compressed data have been written to the backend (or “bulk”), and the internal coder state holds less than one word of additional information content.

Inverted(NonZeroUsize, Word)

The Inverted situation occurs only rarely. In this situation, some full words of compressed data have been held back and not yet written to the backend (or “bulk”) because their final values may still change depending on subsequently encoded symbols.

More precisely, a situation of Inverted(num_subsequent, first_word) means that the held-back words can become either first_word + 1 followed by num_subsequent zero words, or first_word followed by num_subsequent words that have all bits set.

Trait Implementations

impl<Word: Clone> Clone for EncoderSituation<Word>

fn clone(&self) -> EncoderSituation<Word>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Word: Debug> Debug for EncoderSituation<Word>

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

Formats the value using the given formatter.

impl<Word> Default for EncoderSituation<Word>

fn default() -> Self

Returns the “default value” for a type.

impl<Word: PartialEq> PartialEq for EncoderSituation<Word>

fn eq(&self, other: &EncoderSituation<Word>) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<Word: Copy> Copy for EncoderSituation<Word>

impl<Word: Eq> Eq for EncoderSituation<Word>

impl<Word> StructuralEq for EncoderSituation<Word>

impl<Word> StructuralPartialEq for EncoderSituation<Word>