Struct LzfWriter 

pub struct LzfWriter<W: Write> { /* private fields */ }

Available on crate feature encoder only.

Framed LZF stream writer. Writer that encodes framed LZF (ZV block stream).

Data written into this adapter is chunked into blocks and emitted as either compressed or uncompressed ZV blocks.

Implementations

impl<W: Write> LzfWriter<W>

pub fn new(inner: W, block_size: usize) -> Result<Self>

Creates a new framed LZF writer with the given block size (1..=65535).

pub fn new_with_mode( inner: W, block_size: usize, mode: CompressionMode, ) -> Result<Self>

Creates a new framed LZF writer with an explicit compression mode.

pub fn new_with_eof_marker(inner: W, block_size: usize) -> Result<Self>

Creates a writer and enables writing a trailing zero byte EOF marker on finish.

The marker matches the historical lzf utility stream behavior.

pub fn new_with_eof_marker_and_mode( inner: W, block_size: usize, mode: CompressionMode, ) -> Result<Self>

Creates a writer and enables writing a trailing zero byte EOF marker on finish.

Compression mode is explicitly selected.

pub fn into_inner(self) -> W

Unwraps the writer and returns the underlying writer.

pub fn inner(&self) -> &W

Returns a shared reference to the underlying writer.

pub fn inner_mut(&mut self) -> &mut W

Returns a mutable reference to the underlying writer.

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

Finishes the stream and returns the underlying writer.

This flushes any pending input block. If EOF marker mode is enabled, a trailing zero byte is appended after the final block.

pub fn auto_finish(self) -> AutoFinisher<Self>

Returns a wrapper that will call finish() on drop.

This is useful for best-effort stream finalization in scopes with early returns.

Trait Implementations

impl<W: Write> Write for LzfWriter<W>

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

Writes bytes from buf, returning the number of bytes written.

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

Flushes buffered output.

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

Writes all bytes from buf.