zrip-core 0.5.0

Shared types and codecs for zrip (internal crate)
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

#![cfg_attr(not(feature = "std"), no_std)]
#![cfg_attr(feature = "nightly", feature(optimize_attribute))]
#![cfg_attr(feature = "paranoid", forbid(unsafe_code))]

#[cfg(feature = "alloc")]
extern crate alloc;

pub mod error;
pub mod hint;

pub mod bitstream;
pub mod fse;
pub mod hash;
pub mod huffman;
pub mod xxhash;

pub mod block;
pub mod frame;

pub mod simd;

pub mod sequence;
pub use sequence::Sequence;

#[cfg(feature = "alloc")]
pub mod dict;

pub use error::{CompressError, DecompressError, ZstdError};

pub const DEFAULT_DECOMPRESS_LIMIT: usize = usize::MAX;

/// A conservative output limit (128 MiB) suitable for decompressing untrusted input.
///
/// Use this with [`decompress_with_limit`](crate) or [`DecompressContext::decompress_with_limit`]
/// when processing data from untrusted sources to bound memory usage.
pub const SAFE_DECOMPRESS_LIMIT: usize = 128 * 1024 * 1024;

#[doc(hidden)]
pub const LARGE_OUTPUT_THRESHOLD: usize = 512 * 1024;