Struct Encoder 

pub struct Encoder<W> { /* private fields */ }

Streaming LZ4 frame encoder wrapping an inner Write sink.

Bytes written to the encoder are buffered up to the configured block size and then handed to LZ4F_compressUpdate, which emits compressed blocks into w. Always call finish to flush the final block and write the frame footer — dropping the encoder without calling finish produces a truncated frame.

Implementations

impl<W: Write> Encoder<W>

pub fn writer(&self) -> &W

Immutable writer reference.

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

Finalises the LZ4 frame.

Flushes any buffered input, invokes LZ4F_compressEnd to write the frame footer (and content checksum if enabled), and returns the wrapped writer together with the result of writing those final bytes. Always call this; dropping the encoder without finish produces a truncated, undecodable frame.

Trait Implementations

impl<W: Debug> Debug for Encoder<W>

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

Formats the value using the given formatter.

impl<W: Write> Write for Encoder<W>

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

Writes a buffer into this writer, returning how many bytes were written.

fn flush(&mut self) -> Result<()>

Flushes this output stream, ensuring that all intermediately buffered contents reach their destination.

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

Like write, except that it writes from a slice of buffers.

fn is_write_vectored(&self) -> bool

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

Determines if this Writer has an efficient write_vectored implementation.

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

Attempts to write an entire buffer into this writer.

fn write_all_vectored(&mut self, bufs: &mut [IoSlice<'_>]) -> Result<(), Error>

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

Attempts to write multiple buffers into this writer.

fn write_fmt(&mut self, args: Arguments<'_>) -> Result<(), Error>

Writes a formatted string into this writer, returning any error encountered.

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

where Self: Sized,

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