ddidderr/zstd-rs
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Reformat Introduction Comment and Mention Negative Levels

Browse Source
This commit is contained in:
W. Felix Handte
2018-08-22 17:07:34 -07:00
parent 1af27a7ed7
commit e589ac6276
1 changed files with 26 additions and 13 deletions
Download Patch File Download Diff File Expand all files Collapse all files
lib/zstd.h
+26 -13
View File
@@ -35,26 +35,39 @@ extern "C" {
#endif #endif
/******************************************************************************************************* /*******************************************************************************
Introduction Introduction
zstd, short for Zstandard, is a fast lossless compression algorithm, zstd, short for Zstandard, is a fast lossless compression algorithm, targeting
targeting real-time compression scenarios at zlib-level and better compression ratios. real-time compression scenarios at zlib-level and better compression ratios.
The zstd compression library provides in-memory compression and decompression functions. The zstd compression library provides in-memory compression and decompression
The library supports compression levels from 1 up to ZSTD_maxCLevel() which is currently 22. functions.
Levels >= 20, labeled `--ultra`, should be used with caution, as they require more memory.
The library supports regular compression levels from 1 up to ZSTD_maxCLevel(),
which is currently 22. Levels >= 20, labeled `--ultra`, should be used with
caution, as they require more memory. The library also offers negative
compression levels (all negative integers are valid levels), which extend the
range of speed vs. ratio preferences to increasingly extremely strongly
prioritize speed.
Compression can be done in: Compression can be done in:
- a single step (described as Simple API) - a single step (described as Simple API)
- a single step, reusing a context (described as Explicit context) - a single step, reusing a context (described as Explicit context)
- unbounded multiple steps (described as Streaming compression) - unbounded multiple steps (described as Streaming compression)
The compression ratio achievable on small data can be highly improved using a dictionary in:
- a single step (described as Simple dictionary API)
- a single step, reusing a dictionary (described as Bulk-processing dictionary API)
Advanced experimental functions can be accessed using #define ZSTD_STATIC_LINKING_ONLY before including zstd.h. The compression ratio achievable on small data can be highly improved using
Advanced experimental APIs shall never be used with a dynamic library. a dictionary. Dictionary compression can be performed in:
They are not "stable", their definition may change in the future. Only static linking is allowed. - a single step (described as Simple dictionary API)
*********************************************************************************************************/ - a single step, reusing a dictionary (described as Bulk-processing
dictionary API)
Advanced experimental functions can be accessed using
`#define ZSTD_STATIC_LINKING_ONLY` before including zstd.h.
Advanced experimental APIs should never be used with a dynamically-linked
library. They are not "stable"; their definitions or signatures may change in
the future. Only static linking is allowed.
*******************************************************************************/
/*------ Version ------*/ /*------ Version ------*/
#define ZSTD_VERSION_MAJOR 1 #define ZSTD_VERSION_MAJOR 1