mirror of
https://github.com/facebook/zstd.git
synced 2025-11-04 00:02:59 -05:00
64 lines
1.4 KiB
Markdown
64 lines
1.4 KiB
Markdown
zstd - library files
|
|
================================
|
|
|
|
The __lib__ directory contains several files, but depending on target use case, some of them may not be necessary.
|
|
|
|
#### Minimal library files
|
|
|
|
##### Shared ressources
|
|
|
|
- [mem.h](mem.h)
|
|
- [error_private.h](error_private.h)
|
|
- [error_public.h](error_public.h)
|
|
|
|
##### zstd core compression
|
|
|
|
Stable API is exposed in [zstd.h].
|
|
Advanced and experimental API is exposed in `zstd_static.h`.
|
|
`zstd_static.h` API elements should be used with static linking only,
|
|
as their definition may change in future version of the library.
|
|
|
|
- [bitstream.h](bitstream.h)
|
|
- fse.c
|
|
- fse.h
|
|
- fse_static.h
|
|
- huff0.c
|
|
- huff0.h
|
|
- huff0_static.h
|
|
- zstd_compress.c
|
|
- zstd_decompress.c
|
|
- zstd_internal.h
|
|
- zstd_opt.h
|
|
- [zstd.h]
|
|
- zstd_static.h
|
|
|
|
[zstd.h]: zstd.h
|
|
|
|
#### Buffered streaming
|
|
|
|
This complementary API makes streaming integration easier.
|
|
It is used by `zstd` command line utility, and [7zip plugin](http://mcmilk.de/projects/7-Zip-ZStd) :
|
|
|
|
- zbuff.c
|
|
- zbuff.h
|
|
- zbuff_static.h
|
|
|
|
#### Dictionary builder
|
|
|
|
To create dictionaries from training sets :
|
|
|
|
- divsufsort.c
|
|
- divsufsort.h
|
|
- zdict.c
|
|
- zdict.h
|
|
- zdict_static.h
|
|
|
|
#### 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 or dynamic)
|
|
- libzstd.pc.in : for pkg-config (make install)
|
|
|