mzstd 0.2.8

Zstandard (RFC 8878) compression and decompression in safe Rust; single-threaded encoding is byte-identical to zstd 1.5.7
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

//! Structured container compression over one reusable workspace.
//!
//! Native sessions and borrowed one-shot inputs are available with alloc.
//! The std writer and reader adapt the same bounded framing engine. Every
//! chunk of a resource is one independent Zstandard frame, byte-identical
//! to [`Compressor::compress`](crate::Compressor::compress) of its bytes.
//!
//! # Examples
//! ```
//! use mzstd::framing::{FramedCompressor, FramedInput, FramedItem, FramedResource};
//! let items = [FramedItem::Resource(FramedResource::from(&b"hello"[..]))];
//! let mut encoder = FramedCompressor::new(Default::default())?;
//! let bytes = encoder.compress(FramedInput::from(items.as_slice()))?;
//! assert_eq!(&bytes[8..12], b"MZFR");
//! # Ok::<(), Box<dyn std::error::Error>>(())
//! ```

mod config;
mod core;
mod error;
mod input;
mod owner;
#[cfg(not(feature = "no_std"))]
mod reader;
mod session;
#[cfg(not(feature = "no_std"))]
mod writer;

pub use crate::framing::{DictionaryId, DictionaryReference, MetadataField, MetadataKind};
pub use config::*;
pub use error::*;
pub use input::*;
pub use owner::*;
#[cfg(not(feature = "no_std"))]
pub use reader::*;
pub use session::*;
#[cfg(not(feature = "no_std"))]
pub use writer::*;