Struct compress::lz4::Decoder

pub struct Decoder<R> {
    pub r: R,
    // some fields omitted
}

This structure is used to decode a stream of LZ4 blocks. This wraps an internal reader which is read from when this decoder's read method is called.

Fields

r: R

The internally wrapped reader. This is exposed so it may be moved out of. Note that if data is read from the reader while decoding is in progress the output stream will get corrupted.

Implementations

impl<R: Read + Sized> Decoder<R>

pub fn new(r: R) -> Decoder<R>

Creates a new decoder which will read data from the given stream. The inner stream can be re-acquired by moving out of the r field of this structure.

pub fn reset(&mut self)

Resets this decoder back to its initial state. Note that the underlying stream is not seeked on or has any alterations performed on it.

pub fn eof(&mut self) -> bool

Tests whether the end of this LZ4 stream has been reached

Trait Implementations

impl<R: Read> Read for Decoder<R>

fn read(&mut self, dst: &mut [u8]) -> Result<usize>

Pull some bytes from this source into the specified buffer, returning how many bytes were read.

fn read_vectored(&mut self, bufs: &mut [IoSliceMut<'_>]) -> Result<usize, Error>

Like read, except that it reads into a slice of buffers.

fn is_read_vectored(&self) -> bool

🔬 This is a nightly-only experimental API. (can_vector)

Determines if this Reader has an efficient read_vectored implementation.

unsafe fn initializer(&self) -> Initializer

🔬 This is a nightly-only experimental API. (read_initializer)

Determines if this Reader can work with buffers of uninitialized memory.

fn read_to_end(&mut self, buf: &mut Vec<u8>) -> Result<usize, Error>

Read all bytes until EOF in this source, placing them into buf.

fn read_to_string(&mut self, buf: &mut String) -> Result<usize, Error>

Read all bytes until EOF in this source, appending them to buf.

fn read_exact(&mut self, buf: &mut [u8]) -> Result<(), Error>

Read the exact number of bytes required to fill buf.

fn by_ref(&mut self) -> &mut Self

Creates a "by reference" adaptor for this instance of Read.

fn bytes(self) -> Bytes<Self>

Transforms this Read instance to an [Iterator] over its bytes.

fn chain<R>(self, next: R) -> Chain<Self, R> where
    R: Read, 

Creates an adaptor which will chain this stream with another.

fn take(self, limit: u64) -> Take<Self>

Creates an adaptor which will read at most limit bytes from it.