Struct FrameEncoder 

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

Streaming zstd compressor implementing Write.

Buffers input until a full block (128 KiB) is ready, then compresses and writes it to the underlying writer. Call finish to flush the final block, write the content checksum, and recover the writer.

Internal buffers (hash tables, sequence scratch, block encoder workspace) are allocated once and reused across blocks. To reuse them across multiple frames, call reset instead of finish:

use std::io::Write;

let mut encoder = zrip::FrameEncoder::new(Vec::new(), 1).unwrap();
encoder.write_all(b"first frame").unwrap();
let first = encoder.reset(Vec::new()).unwrap();   // reuses buffers
encoder.write_all(b"second frame").unwrap();
let second = encoder.finish().unwrap();

Implementations

impl<W: Write> FrameEncoder<W>

pub fn new(writer: W, level: i32) -> Result<Self, CompressError>

Creates a new streaming encoder at the given level (-7..=4).

pub fn with_dict( writer: W, level: i32, dict: Dictionary, ) -> Result<Self, CompressError>

Creates a new streaming encoder with a dictionary at the given level (-7..=4).

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

Flushes remaining data, writes the content checksum, and returns the inner writer.

pub fn reset(&mut self, new_writer: W) -> Result<W, Error>

Finishes the current frame and installs new_writer for the next one.

Returns the previous writer containing the completed frame. All internal buffers (hash tables, workspace, block scratch) stay allocated and are reused for the next frame.

Trait Implementations

impl<W: Write> Write for FrameEncoder<W>

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