Struct Encoder 

pub struct Encoder { /* private fields */ }

Stateful encoder that reuses internal hash-table buffers across calls.

The free functions encode, encode_better, encode_best, and encode_snappy allocate a fresh hash table on every invocation. For hot loops compressing many small blocks, allocating and zero-filling that buffer every time is a measurable fraction of the call cost (≈ 50–80 % for ≤ 1 KB inputs).

An Encoder holds these buffers and grows them lazily on first use, so repeated calls in the same mode pay only the in-cache memset cost instead of going through the system allocator. Output is bit-for-bit identical to the equivalent free function for every input.

Example

use minlz::Encoder;

let mut enc = Encoder::new();
let mut compressed_blocks: Vec<Vec<u8>> = (0..1000)
    .map(|i| enc.encode(&[i as u8; 256]))
    .collect();

Implementations

impl Encoder

pub fn new() -> Self

Create a new encoder with no buffers allocated yet.

pub fn encode(&mut self, src: &[u8]) -> Vec<u8>

Encode src using the standard (fast) algorithm. Equivalent to the free encode() function but reuses internal hash-table storage across calls.

pub fn encode_better(&mut self, src: &[u8]) -> Vec<u8>

Encode src using the better-compression algorithm. Equivalent to the free encode_better() function with internal buffer reuse.

pub fn encode_best(&mut self, src: &[u8]) -> Vec<u8>

Encode src using the best-compression algorithm. Equivalent to the free encode_best() function with internal buffer reuse. Buffer reuse matters most here because the best-mode hash tables are 4.5 MiB total.

pub fn encode_snappy(&mut self, src: &[u8]) -> Vec<u8>

Encode src in Snappy-compatible format. Equivalent to the free encode_snappy() function with internal buffer reuse.

Trait Implementations

impl Default for Encoder

fn default() -> Encoder

Returns the “default value” for a type.