Crate zstd_zero 

zstd-zero

zstd-zero is an experimental, safe Rust decoder for standard Zstandard frames. The crate is no_std, has no dependencies, and never allocates.

It requires Rust 1.75 or newer and contains no unsafe code (#![forbid(unsafe_code)]).

[dependencies]
zstd-zero = "0.2"

The caller supplies six reusable buffers:

• history at least as large as the frame’s declared window;
• compressed-block scratch, up to 128 KiB;
• regenerated-literals scratch, up to 128 KiB;
• FSE_ENTRIES initialized FseEntry slots for sequence tables and Huffman weight scratch;
• FSE_SCRATCH_LEN i16 elements (512 bytes), shared across all table builds;
• HUFFMAN_ENTRIES initialized HuffmanEntry slots for the literal table.

Entropy tables borrow these buffers instead of living inside Decoder or in large temporary stack arrays. Use Default for heap-backed entries or the const FseEntry::new() / HuffmanEntry::new() constructors for static arrays. Decoder::new and Decoder::with_options return an error if an entropy-table or FSE scratch buffer is too short. FSE scratch contents can be arbitrary: table construction reuses the same slice first for probabilities and then for next-state counters. Reset retains the buffers and invalidates the previous tables.

Decoded bytes are returned as short-lived slices borrowed directly from the history buffer. Dictionary, legacy, and magicless frames are not supported.

use zstd_zero::{DecodeStep, Decoder, DecoderBuffers, MAX_BLOCK_SIZE};

let mut history = [0u8; 8 * 1024];
let mut block = [0u8; MAX_BLOCK_SIZE];
let mut literals = [0u8; MAX_BLOCK_SIZE];
let mut fse_scratch = [0i16; zstd_zero::FSE_SCRATCH_LEN];
let mut fse = vec![zstd_zero::FseEntry::default(); zstd_zero::FSE_ENTRIES];
let mut huffman = vec![zstd_zero::HuffmanEntry::default(); zstd_zero::HUFFMAN_ENTRIES];
let mut decoder = Decoder::new(DecoderBuffers {
    history: &mut history,
    block: &mut block,
    literals: &mut literals,
    fse_scratch: &mut fse_scratch,
    fse: &mut fse,
    huffman: &mut huffman,
}).unwrap();

// Feed arbitrary input fragments. Every step reports how much input it used;
// consume an Output slice before calling the decoder again.
let step = decoder.decode(&compressed)?;
if let DecodeStep::Output { bytes, .. } = step {
    consume(bytes);
}

At end-of-input, call decode(&[]) until it returns NeedInput, then call finish() to detect truncation. Output may have been observed before a final content checksum fails, so callers that need atomic behavior must use a transactional sink.

The crate is published separately so applications can use the decoder without depending on OCI registry functionality.

Testing

The test suite compares against libzstd across compression levels and input fragmentation patterns. The differential suite generates 256 deterministic frames across payload families, boundary sizes, compression levels and strategies, frame and block options, exact declared history windows, and streaming fragmentation, then decodes each with both libzstd and zstd-zero. It also cross-checks a concatenated stream containing Zstandard and skippable frames. Increase or reduce the generated case count with ZSTD_ZERO_CROSSCHECK_CASES:

ZSTD_ZERO_CROSSCHECK_CASES=1024 cargo test -p zstd-zero --test differential

That corpus is derived from a fixed base seed, so every push replays the same 256 frames. A nightly workflow runs a much larger corpus from a changing seed and prints the seed it used; ZSTD_ZERO_CROSSCHECK_SEED reproduces such a run exactly:

ZSTD_ZERO_CROSSCHECK_CASES=25000 ZSTD_ZERO_CROSSCHECK_SEED=<seed> \
  cargo test -p zstd-zero --release --test differential

CI also builds zstd 1.5.7’s official decodecorpus generator and checks 256 deterministic no-dictionary frames. The same check can be run locally with:

DECODECORPUS=/path/to/decodecorpus cargo test -p zstd-zero \
  --test conformance decodes_official_decodecorpus_frames -- --ignored

Licensed under either Apache-2.0 or MIT, at your option.

Structs

Decoder

DecoderBuffers

Initialized caller-owned storage, retained for the decoder’s lifetime.

DecoderOptions

Tuning knobs for a Decoder.

FrameHeader

FseEntry

An initialized entropy-table slot; the decoder manages its contents.

HuffmanEntry

An initialized entropy-table slot; the decoder manages its contents.

Enums

DecodeError

DecodeStep

FrameKind

HeaderStatus

StreamError

A failure while driving a Decoder through its callback API.

StreamHeader

Constants

FSE_ENTRIES

FSE slots required for three sequence tables and Huffman weight scratch.

FSE_SCRATCH_LEN

Number of scratch counters shared by all FSE table constructors. Contents may be arbitrary on entry and are not retained across tables.

HUFFMAN_ENTRIES

Huffman slots required for literal decoding.

MAX_BLOCK_SIZE

MAX_FRAME_HEADER_SIZE

Functions

inspect_frame