Trait constriction::backends::AsReadWords

pub trait AsReadWords<'a, Word, S: Semantics>: 'a {
    type AsReadWords: ReadWords<Word, S>;

    // Required method
    fn as_read_words(&'a self) -> Self::AsReadWords;
}

A trait for types that can be temporarily used by decoders as a source of compressed data.

This trait is meant for situations where you want to use some data as a source of Words without consuming it. This allows you to decode the same compressed data several times but it means that you typically won’t be allowed to return the resulting data source or any entropy coder that wraps it from the current function because it doesn’t take ownership of the data. If you want to take ownership of the data, use IntoReadWords instead.

Note that, if you want to decode the same compressed data several times then you’ll probably want to decode different parts of that data each time. In this case, it’s likely you’ll rather want to use AsSeekReadWords.

See also

• module level documentation for more information on the concept of sources and sinks of compressed data;
• IntoReadWords for a simliar conversion that takes ownership of the data;
• AsSeekReadWords for a conversion with stronger guarantees.

Required Associated Types

type AsReadWords: ReadWords<Word, S>

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

Required Methods

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

Performs the (temporary) conversion.

Implementors

impl<'a, Word: Clone + 'a, Buf: AsRef<[Word]> + 'a> AsReadWords<'a, Word, Queue> for Buf

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

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

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