Struct Decoder 

pub struct Decoder<R> { /* private fields */ }

Streaming LZ4 frame decoder wrapping an inner Read source.

Pull bytes via the Read impl; the decoder transparently reads from the source, feeds compressed input into LZ4F_decompress, and emits decompressed bytes into the caller’s buffer. When the frame ends, further reads return Ok(0). Call finish to recover the inner reader and confirm the frame was fully consumed.

Implementations

impl<R: Read> Decoder<R>

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

Creates a new decoder which reads its input from the given input stream. The input stream can be re-acquired by calling finish()

pub fn reader(&self) -> &R

Immutable reader reference.

pub fn finish(self) -> (R, Result<()>)

Returns the wrapped reader together with a status result.

The result is Ok(()) if the LZ4 frame was fully consumed (the frame footer and any content checksum were read and accepted) and Err(ErrorKind::Interrupted) if finish was called before the end of the compressed stream.

Trait Implementations

impl<R: Debug> Debug for Decoder<R>

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

Formats the value using the given formatter.

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

fn read(&mut self, buf: &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.

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

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

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

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

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

Reads the exact number of bytes required to fill buf.

fn read_buf(&mut self, buf: BorrowedCursor<'_>) -> Result<(), Error>

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

Pull some bytes from this source into the specified buffer.

fn read_buf_exact(&mut self, cursor: BorrowedCursor<'_>) -> Result<(), Error>

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

Reads the exact number of bytes required to fill cursor.

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

where Self: Sized,

Creates a “by reference” adapter for this instance of Read.

fn bytes(self) -> Bytes<Self>

where Self: Sized,

Transforms this Read instance to an Iterator over its bytes.

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

where R: Read, Self: Sized,

Creates an adapter which will chain this stream with another.

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

where Self: Sized,

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

fn read_array<const N: usize>(&mut self) -> Result<[u8; N], Error>

where Self: Sized,

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

Read and return a fixed array of bytes from this source.

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