libzstd-bitexact-rs 0.157.0

Pure-Rust reimplementation of Zstandard, aiming for bit-exact parity with the C libzstd
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62

//! A pure-Rust reimplementation of [Zstandard](https://facebook.github.io/zstd/),
//! built to be **bit-exact** with the reference C implementation.
//!
//! Decompression is complete: dictionaries (raw-content and trained/`ZDICT`),
//! a configurable `windowLogMax`, and a [`Read`]-based [`StreamDecoder`] with
//! a bounded sliding window. [`compress`] produces frames **byte-identical to
//! C libzstd 1.5.7 at every level** (1–22 and the negative levels), and
//! [`StreamEncoder`] mirrors `ZSTD_compressStream2` flush/end behavior (see
//! its docs for the current streaming length scope). Every table and loop is
//! a faithful port of its counterpart in the C sources, and the crate is
//! continuously differential-tested against the real libzstd — see
//! `ROADMAP.md` for what remains.
//!
//! [`decompress`] and [`decompress_with_limit`] cover the common one-shot
//! cases; [`DecodeOptions`] composes an output limit, a maximum window log,
//! and a [`Dictionary`]; [`StreamDecoder`] decodes incrementally from any
//! reader.
//!
//! [`Read`]: std::io::Read
//!
//! ```
//! // A tiny handcrafted frame: single-segment, content size 5, one RLE
//! // block repeating `a` five times.
//! let frame = [0x28, 0xB5, 0x2F, 0xFD, 0x20, 0x05, 0x2B, 0x00, 0x00, b'a'];
//! assert_eq!(libzstd_bitexact_rs::decompress(&frame).unwrap(), b"aaaaa");
//! ```

#![forbid(unsafe_code)]

mod bits;
mod block;
mod compress;
mod decompress;
mod dict_encode;
mod dictionary;
mod error;
mod frame;
mod fse;
mod fse_encode;
mod huffman;
mod huffman_encode;
mod lazy;
mod ldm;
mod literals_encode;
mod opt;
mod post_split;
mod pre_split;
mod sequences_encode;
mod stream;
mod stream_encode;
mod xxhash;

pub use compress::{
    compress, compress_mt, compress_mt_with_dict, compress_with_cdict, compress_with_dict,
};
#[doc(hidden)]
pub use compress::{cparams_create_cdict_for_testing, cparams_for_testing};
pub use decompress::{DecodeOptions, WINDOW_LOG_MAX, decompress, decompress_with_limit};
pub use dictionary::Dictionary;
pub use error::Error;
pub use stream::StreamDecoder;
pub use stream_encode::StreamEncoder;