zstd/examples
Yann Collet 3f7a1b1328 added a few documentation words about dictionary training
partially answering questions such as #3233
which looks for guidance within `exmaples/`.
2022-08-05 17:09:22 +02:00
..
.gitignore edit README.md and remove simple_compressionCCtx.c 2018-12-16 21:09:21 -08:00
Makefile [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
README.md edit README.md and remove simple_compressionCCtx.c 2018-12-16 21:09:21 -08:00
common.h added a few documentation words about dictionary training 2022-08-05 17:09:22 +02:00
dictionary_compression.c added a few documentation words about dictionary training 2022-08-05 17:09:22 +02:00
dictionary_decompression.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
multiple_simple_compression.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
multiple_streaming_compression.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
simple_compression.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
simple_decompression.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
streaming_compression.c typo: Small spelling mistake in example 2021-12-11 12:02:23 +01:00
streaming_compression_thread_pool.c Fix mini typo 2021-12-28 09:04:28 -08:00
streaming_decompression.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00
streaming_memory_usage.c [copyright][license] Switch to yearless copyright and some cleanup in the linux-kernel files 2021-03-30 10:30:43 -07:00

README.md

Zstandard library : usage examples

  • Simple compression : Compress a single file. Introduces usage of : ZSTD_compress()

  • Simple decompression : Decompress a single file. Only compatible with simple compression. Result remains in memory. Introduces usage of : ZSTD_decompress()

  • Multiple simple compression : Compress multiple files (in simple mode) in a single command line. Demonstrates memory preservation technique that minimizes malloc()/free() calls by re-using existing resources. Introduces usage of : ZSTD_compressCCtx()

  • Streaming memory usage : Provides amount of memory used by streaming context. Introduces usage of : ZSTD_sizeof_CStream()

  • Streaming compression : Compress a single file. Introduces usage of : ZSTD_compressStream()

  • Multiple Streaming compression : Compress multiple files (in streaming mode) in a single command line. Introduces memory usage preservation technique, reducing impact of malloc()/free() and memset() by re-using existing resources.

  • Streaming decompression : Decompress a single file compressed by zstd. Compatible with both simple and streaming compression. Result is sent to stdout. Introduces usage of : ZSTD_decompressStream()

  • Dictionary compression : Compress multiple files using the same dictionary. Introduces usage of : ZSTD_createCDict() and ZSTD_compress_usingCDict()

  • Dictionary decompression : Decompress multiple files using the same dictionary. Result remains in memory. Introduces usage of : ZSTD_createDDict() and ZSTD_decompress_usingDDict()