The lib directory contains several directories. Depending on target use case, it's enough to include only files from relevant directories.
Zstandard's stable API is exposed within zstd.h, at the root of lib
directory.
Some additional API may be useful if you're looking into advanced features :
size_t
function results into an enum
, for precise error handling.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.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
.
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.
The other files are not source code. There are :
make install
)