Struct StreamingEncoder 

pub struct StreamingEncoder<W: Write, M: Matcher = MatchGeneratorDriver> { /* private fields */ }

Incremental frame encoder that implements Write.

Data can be provided with multiple write() calls. Full blocks are compressed automatically, flush() emits the currently buffered partial block as non-last, and finish() closes the frame and returns the wrapped writer.

Implementations

impl<W: Write> StreamingEncoder<W, MatchGeneratorDriver>

pub fn new(drain: W, compression_level: CompressionLevel) -> Self

Creates a streaming encoder backed by the default match generator.

The encoder writes compressed bytes into drain and applies compression_level to all subsequently written blocks.

impl<W: Write, M: Matcher> StreamingEncoder<W, M>

pub fn new_with_matcher( matcher: M, drain: W, compression_level: CompressionLevel, ) -> Self

Creates a streaming encoder with an explicitly provided matcher implementation.

This constructor is primarily intended for tests and advanced callers that need custom match-window behavior.

pub fn set_pledged_content_size(&mut self, size: u64) -> Result<(), Error>

Pledge the total uncompressed content size for this frame.

When set, the frame header will include a Frame_Content_Size field. This enables decoders to pre-allocate output buffers.

Must be called before the first write call; calling it after the frame header has already been emitted returns an error.

pub fn get_ref(&self) -> &W

Returns an immutable reference to the wrapped output drain.

The drain remains available for the encoder lifetime; finish consumes the encoder and returns ownership of the drain.

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

Returns a mutable reference to the wrapped output drain.

It is inadvisable to directly write to the underlying writer, as doing so would corrupt the zstd frame being assembled by the encoder.

The drain remains available for the encoder lifetime; finish consumes the encoder and returns ownership of the drain.

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

Finalizes the current zstd frame and returns the wrapped output drain.

If no payload was written yet, this still emits a valid empty frame. Calling this method consumes the encoder.

Trait Implementations

impl<W: Write, M: Matcher> Write for StreamingEncoder<W, M>

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

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

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

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.