Struct constriction::Stack

pub struct Stack {}

Zero sized marker trait for last-in-first-out read/write Semantics

This type typically only comes up in advanced use cases that are generic over read/write semantics. If you are looking for an entropy coder that operates as a stack, check out the module stream::stack.

Trait Implementations

impl<'a, Word: Clone + 'a, Buf: SafeBuf<Word> + 'a> AsReadWords<'a, Word, Stack> for Buf

type AsReadWords = Cursor<Word, &'a [Word]>

The type of the data source as which the original type can be used.

fn as_read_words(&'a self) -> Self::AsReadWords

Performs the (temporary) conversion.

impl<Array> BoundedReadWords<<Array as Array>::Item, Stack> for SmallVec<Array> where
    Array: Array, 

fn remaining(&self) -> usize

Returns the number of Words that are left for reading.

fn is_exhausted(&self) -> bool

Whether or not there is no data left to read.

impl<Word> BoundedReadWords<Word, Stack> for Vec<Word>

fn remaining(&self) -> usize

Returns the number of Words that are left for reading.

fn is_exhausted(&self) -> bool

Whether or not there is no data left to read.

impl<Word, B: BoundedReadWords<Word, Queue>> BoundedReadWords<Word, Stack> for Reverse<B>

fn remaining(&self) -> usize

Returns the number of Words that are left for reading.

fn is_exhausted(&self) -> bool

Whether or not there is no data left to read.

impl<Word: Clone, Buf: SafeBuf<Word>> BoundedReadWords<Word, Stack> for Cursor<Word, Buf>

fn remaining(&self) -> usize

Returns the number of Words that are left for reading.

fn is_exhausted(&self) -> bool

Whether or not there is no data left to read.

impl Debug for Stack

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

Formats the value using the given formatter.

impl Default for Stack

fn default() -> Stack

Returns the “default value” for a type.

impl<Word: Clone, Buf: SafeBuf<Word>> IntoReadWords<Word, Stack> for Buf

type IntoReadWords = Cursor<Word, Buf>

The type of the data source that will result from the conversion.

fn into_read_words(self) -> Self::IntoReadWords

Performs the conversion.

impl<Word: BitArray, B: ReadWords<Word, Stack>> ReadBitStream<Stack> for StackCoder<Word, B>

type ReadError = B::ReadError

fn decode_symbol<C: DecoderCodebook>(
    &mut self,
    codebook: C
) -> Result<C::Symbol, CoderError<SymbolCodeError<C::InvalidCodeword>, Self::ReadError>>

fn read_bit(&mut self) -> Result<Option<bool>, Self::ReadError>

fn decode_symbols<'s, I, C>(
    &'s mut self,
    codebooks: I
) -> DecodeSymbols<'s, Self, I, S> where
    I: IntoIterator<Item = C> + 's,
    C: DecoderCodebook, 

fn decode_iid_symbols<'a, C>(
    &'a mut self,
    amt: usize,
    codebook: &'a C
) -> DecodeSymbols<'a, Self, Take<Repeat<&'a C>>, S> where
    C: DecoderCodebook, 

impl<Array> ReadWords<<Array as Array>::Item, Stack> for SmallVec<Array> where
    Array: Array, 

type ReadError = Infallible

The only way how reading from a vector can fail is if the vector is empty, but that’s not considered an error (it returns Ok(None) instead).

fn read(&mut self) -> Result<Option<Array::Item>, Self::ReadError>

Pops the word off the end of the vector (= top of the stack). If you instead want to keep the data unchanged (e.g., because you want to reuse it later) then wrap either the vector v or or the slice &v[..] in a Cursor.

fn maybe_exhausted(&self) -> bool

Returns true if the data source could be out of data.

impl<Word> ReadWords<Word, Stack> for Vec<Word>

type ReadError = Infallible

The only way how reading from a vector can fail is if the vector is empty, but that’s not considered an error (it returns Ok(None) instead).

fn read(&mut self) -> Result<Option<Word>, Self::ReadError>

Pops the word off the end of the vector (= top of the stack). If you instead want to keep the data unchanged (e.g., because you want to reuse it later) then wrap either the vector v or or the slice &v[..] in a Cursor.

fn maybe_exhausted(&self) -> bool

Returns true if the data source could be out of data.

impl<Word, B: ReadWords<Word, Queue>> ReadWords<Word, Stack> for Reverse<B>

type ReadError = B::ReadError

The error type that can occur when reading from the data source, or Infallible.

fn read(&mut self) -> Result<Option<Word>, Self::ReadError>

Reads a single Word from the data source and advances the state of the data source accordingly (i.e., so that the next read won’t read the same Word again).

fn maybe_exhausted(&self) -> bool

Returns true if the data source could be out of data.

impl<Word: Clone, Buf: SafeBuf<Word>> ReadWords<Word, Stack> for Cursor<Word, Buf>

type ReadError = Infallible

The error type that can occur when reading from the data source, or Infallible.

fn read(&mut self) -> Result<Option<Word>, Self::ReadError>

Reads a single Word from the data source and advances the state of the data source accordingly (i.e., so that the next read won’t read the same Word again).

fn maybe_exhausted(&self) -> bool

Returns true if the data source could be out of data.

impl<Word: BitArray, B: WriteWords<Word>> WriteBitStream<Stack> for StackCoder<Word, B>

type WriteError = B::WriteError

fn write_bit(&mut self, bit: bool) -> Result<(), Self::WriteError>

fn encode_symbol<Symbol, C>(
    &mut self,
    symbol: Symbol,
    codebook: C
) -> Result<(), CoderError<DefaultEncoderFrontendError, Self::WriteError>> where
    Symbol: Borrow<C::Symbol>,
    C: EncoderCodebook, 

fn encode_symbols<Symbol, C>(
    &mut self,
    symbols_and_codebooks: impl IntoIterator<Item = (Symbol, C)>
) -> Result<(), CoderError<DefaultEncoderFrontendError, Self::WriteError>> where
    C: EncoderCodebook,
    Symbol: Borrow<C::Symbol>, 

fn encode_iid_symbols<Symbol, C>(
    &mut self,
    symbols: impl IntoIterator<Item = Symbol>,
    codebook: &C
) -> Result<(), CoderError<DefaultEncoderFrontendError, Self::WriteError>> where
    C: EncoderCodebook,
    Symbol: Borrow<C::Symbol>, 

impl Semantics for Stack