Expand description
Minimal safe wrapper around zstd-sys.
This crates provides a minimal translation of the zstd-sys methods. For a more comfortable high-level library, see the zstd crate.
Most of the functions here map 1-for-1 to a function from the C zstd library mentioned in their descriptions. Check the source documentation for more information on their behaviour.
Features denoted as experimental in the C library are hidden behind an
experimental
feature.
Re-exports
pub use zstd_sys;
Structs
Compression context
Compression dictionary.
Indicates an error happened when parsing the frame content size.
A Decompression Context.
A digested decompression dictionary.
Wrapper around an input buffer.
Wrapper around an output buffer.
Enums
A compression parameter.
A decompression parameter.
DictAttachPref
experimental
FrameFormat
experimental
ParamSwitch
experimental
What kind of context reset should be applied.
How to compress data.
Advanced compression API (Requires v1.4.0+)
Constants
Traits
Describe a resizeable bytes container like
Vec<u8>
.Functions
Wraps the
ZSTD_compress
function.Maximum compressed size in worst case single-pass scenario
Wraps the
ZSTD_compress_usingCDict()
function.Wraps the
ZSTD_createCDict()
function.Allocates a new
CStream
.Wraps the
ZSTD_createDDict()
function.Wraps the
ZSTD_decompress
function.decompress_bound
experimental
Wraps the
ZSTD_decompressBound
functionWraps the
ZSTD_decompress_usingDDict()
function.find_decompressed_size
experimental
Wraps the
ZSTD_findDecompressedSize()
function.Wraps the
ZSTD_findFrameCompressedSize()
function.get_block_size
experimental
Wraps the
ZSTD_getBlockSize()
function.get_decompressed_sizeDeprecated
Wraps the
ZSTD_getDecompressedSize
function.get_dict_id
zdict_builder
Wraps the
ZDICT_getDictID()
function.Wraps the
ZSTD_getDictID_fromDict()
function.Wraps the
ZSTD_getDictID_fromFrame()
function.Returns the error string associated with an error code.
Wraps the
ZSTD_getFrameContentSize()
function.Prepares an existing
CStream
for compression at the given level.is_frame
experimental
Wraps the
ZSTD_isFrame()
function.Returns the maximum (slowest) compression level supported.
Returns the minimum (fastest) compression level supported.
train_from_buffer
zdict_builder
Wraps the
ZDICT_trainFromBuffer()
function.Returns the ZSTD version.
Returns a string representation of the ZSTD version.
Type Definitions
Compression stream.
Represents the compression level used by zstd.
A Decompression stream.
Represents a possible error from the zstd library.
Wrapper result around most zstd functions.