Struct ZstdCompressor 

pub struct ZstdCompressor { /* private fields */ }

Zstandard compressor.

Supports custom FSE tables for sequence encoding via with_custom_tables() and custom Huffman tables for literals via with_custom_huffman().

Example

use haagenti_zstd::{ZstdCompressor, CustomFseTables};
use haagenti_core::Compressor;

// Using predefined tables (default)
let compressor = ZstdCompressor::new();
let compressed = compressor.compress(b"Hello, World!").unwrap();

// Using custom FSE tables
let custom_tables = CustomFseTables::new();
let compressor = ZstdCompressor::with_custom_tables(custom_tables);

Implementations

impl ZstdCompressor

pub fn new() -> Self

Create a new Zstd compressor with default settings.

pub fn with_level(level: CompressionLevel) -> Self

Create with compression level.

pub fn with_custom_tables(custom_tables: CustomFseTables) -> Self

Create with custom FSE tables.

Custom tables override the predefined FSE tables used for sequence encoding. Tables can be built from symbol distributions using FseTable::from_predefined().

Performance Note

When using custom tables, the bitstream will include the table description in the mode byte, adding some overhead. Use custom tables when:

• The data has symbol distributions that differ significantly from predefined
• Better compression ratio is worth the table overhead

pub fn with_custom_huffman(custom_huffman: CustomHuffmanTable) -> Self

Create with custom Huffman table for literals.

Custom Huffman tables allow using pre-trained encoders for literal compression. This can improve compression when the data has known byte distributions.

pub fn with_level_and_tables( level: CompressionLevel, custom_tables: CustomFseTables, ) -> Self

Create with both compression level and custom FSE tables.

pub fn with_all_options( level: CompressionLevel, custom_tables: Option<CustomFseTables>, custom_huffman: Option<CustomHuffmanTable>, ) -> Self

Create with all custom options.

pub fn custom_tables(&self) -> Option<&CustomFseTables>

Get the custom FSE tables, if any.

pub fn custom_huffman(&self) -> Option<&CustomHuffmanTable>

Get the custom Huffman table, if any.

Trait Implementations

impl Clone for ZstdCompressor

fn clone(&self) -> ZstdCompressor

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Compressor for ZstdCompressor

fn algorithm(&self) -> Algorithm

Get the compression algorithm.

fn level(&self) -> CompressionLevel

Get the configured compression level.

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

Compress data in one shot.

fn compress_to(&self, input: &[u8], output: &mut [u8]) -> Result<usize>

Compress data into existing buffer.

fn max_compressed_size(&self, input_len: usize) -> usize

Calculate maximum compressed size for input length. Useful for pre-allocating output buffers.

fn stats(&self) -> Option<CompressionStats>

Get compression statistics after operation.

impl Debug for ZstdCompressor

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

Formats the value using the given formatter.

impl Default for ZstdCompressor

fn default() -> Self

Returns the “default value” for a type.