Struct ZstdEncoder 

pub struct ZstdEncoder { /* private fields */ }

Zstandard encoder.

Supports multiple compression levels (0-22) with LZ77 matching, Huffman literal encoding, and FSE sequence encoding.

Supports optional progress reporting via ProgressHandle and cooperative cancellation via CancellationToken using the ZstdEncoder::with_progress / ZstdEncoder::with_cancel builders.

Implementations

impl ZstdEncoder

pub fn new() -> Self

Create a new encoder with default settings (level 0, RLE strategy).

pub fn with_progress(self, handle: ProgressHandle) -> Self

Attach a progress sink.

The sink’s on_progress(bytes_processed, None) is called after each block is written to the output. on_finish() is called after the content checksum is written.

pub fn with_cancel(self, token: CancellationToken) -> Self

Attach a cancellation token.

The token is checked before each block is encoded. If cancelled, returns oxiarc_core::error::OxiArcError::Cancelled.

pub fn set_checksum(&mut self, include: bool) -> &mut Self

Set whether to include content checksum.

pub fn set_content_size(&mut self, include: bool) -> &mut Self

Set whether to include content size in header.

pub fn set_strategy(&mut self, strategy: CompressionStrategy) -> &mut Self

Set compression strategy (only effective when level == 0).

pub fn set_level(&mut self, level: i32) -> &mut Self

Set compression level (0-22).

• Level 0: Raw/RLE blocks (fastest, no compression)
• Levels 1-3: Fast compression (greedy matching)
• Levels 4-9: Balanced compression (lazy matching)
• Levels 10-22: High compression (deep search)

pub fn set_dictionary(&mut self, dict: &[u8]) -> &mut Self

Set a pre-trained dictionary for improved compression of small data.

pub fn compress(&self, data: &[u8]) -> Result<Vec<u8>>

Compress data into a Zstandard frame.

Uses the configured compression level and strategy.

Trait Implementations

impl Clone for ZstdEncoder

fn clone(&self) -> ZstdEncoder

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ZstdEncoder

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

Formats the value using the given formatter.

impl Default for ZstdEncoder

fn default() -> Self

Returns the “default value” for a type.