AuroraMiddleware/zstd
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
984b66cd72
zstd/lib
History
Przemyslaw Skibinski 984b66cd72 added contrib\gen_html
2016-10-24 15:59:51 +02:00
..
common added ZSTD_error_frameParameter_windowTooLarge (#403) 2016-10-12 17:29:24 -07:00
compress zstd_compression_format.md moved to doc/ 2016-10-24 15:58:07 +02:00
decompress zstd_compression_format.md moved to doc/ 2016-10-24 15:58:07 +02:00
dictBuilder improved dicitonary segment merge 2016-10-18 16:34:58 -07:00
legacy detect early impossible decompression scenario in legacy decoder v0.5 2016-10-18 13:48:32 -07:00
.gitignore Added "dictionary decompression" example 2016-07-07 14:08:00 +02:00
libzstd.pc.in fixed a few links 2016-09-02 22:11:49 -07:00
Makefile make creates libzstd binaries (#415) 2016-10-12 11:09:36 -07:00
README.md updated README.md 2016-08-29 13:04:26 +02:00
zstd.h added contrib\gen_html 2016-10-24 15:59:51 +02:00

README.md

Zstandard library files

The lib directory contains several directories. Depending on target use case, it's enough to include only files from relevant directories.

API

Zstandard's stable API is exposed within zstd.h, at the root of lib directory.

Advanced API

Some additional API may be useful if you're looking into advanced features :

  • common/error_public.h : transforms size_t function results into an enum, for precise error handling.
  • ZSTD_STATIC_LINKING_ONLY : if you define this macro before including zstd.h, it will give access to advanced and experimental API. These APIs shall never be used with dynamic library ! They are not "stable", their definition may change in the future. Only static linking is allowed.

Modular build

Directory common/ is required in all circumstances. You can select to support compression only, by just adding files from the compress/ directory, In a similar way, you can build a decompressor-only library with the decompress/ directory.

Other optional functionalities provided are :

  • dictBuilder/ : source files to create dictionaries. The API can be consulted in dictBuilder/zdict.h. This module also depends on common/ and compress/ .

  • legacy/ : source code to decompress previous versions of zstd, starting from v0.1. This module also depends on common/ and decompress/ . Library compilation must include directive ZSTD_LEGACY_SUPPORT = 1 . The main API can be consulted in legacy/zstd_legacy.h. Advanced API from each version can be found in their relevant header file. For example, advanced API for version v0.4 is in legacy/zstd_v04.h .

Obsolete streaming API

Streaming is now provided within zstd.h. Older streaming API is still provided within common/zbuff.h. It is considered obsolete, and will be removed in a future version. Consider migrating towards newer streaming API.

Miscellaneous

The other files are not source code. There are :

  • LICENSE : contains the BSD license text
  • Makefile : script to compile or install zstd library (static and dynamic)
  • libzstd.pc.in : for pkg-config (make install)
  • README.md : this file