zstd/examples
Josh Soref a880ca239b Spelling (#1582)
* spelling: accidentally

* spelling: across

* spelling: additionally

* spelling: addresses

* spelling: appropriate

* spelling: assumed

* spelling: available

* spelling: builder

* spelling: capacity

* spelling: compiler

* spelling: compressibility

* spelling: compressor

* spelling: compression

* spelling: contract

* spelling: convenience

* spelling: decompress

* spelling: description

* spelling: deflate

* spelling: deterministically

* spelling: dictionary

* spelling: display

* spelling: eliminate

* spelling: preemptively

* spelling: exclude

* spelling: failure

* spelling: independence

* spelling: independent

* spelling: intentionally

* spelling: matching

* spelling: maximum

* spelling: meaning

* spelling: mishandled

* spelling: memory

* spelling: occasionally

* spelling: occurrence

* spelling: official

* spelling: offsets

* spelling: original

* spelling: output

* spelling: overflow

* spelling: overridden

* spelling: parameter

* spelling: performance

* spelling: probability

* spelling: receives

* spelling: redundant

* spelling: recompression

* spelling: resources

* spelling: sanity

* spelling: segment

* spelling: series

* spelling: specified

* spelling: specify

* spelling: subtracted

* spelling: successful

* spelling: return

* spelling: translation

* spelling: update

* spelling: unrelated

* spelling: useless

* spelling: variables

* spelling: variety

* spelling: verbatim

* spelling: verification

* spelling: visited

* spelling: warming

* spelling: workers

* spelling: with
2019-04-12 11:18:11 -07:00
..
.gitignore edit README.md and remove simple_compressionCCtx.c 2018-12-16 21:09:21 -08:00
Makefile [examples] Clean up and comment the examples 2019-04-05 21:02:07 -07:00
README.md edit README.md and remove simple_compressionCCtx.c 2018-12-16 21:09:21 -08:00
common.h [examples] Clean up and comment the examples 2019-04-05 21:02:07 -07:00
dictionary_compression.c [examples] Clean up and comment the examples 2019-04-05 21:02:07 -07:00
dictionary_decompression.c [examples] Clean up and comment the examples 2019-04-05 21:02:07 -07:00
multiple_simple_compression.c Spelling (#1582) 2019-04-12 11:18:11 -07:00
multiple_streaming_compression.c [examples] Clean up and comment the examples 2019-04-05 21:02:07 -07:00
simple_compression.c [examples] Clean up and comment the examples 2019-04-05 21:02:07 -07:00
simple_decompression.c [examples] Clean up and comment the examples 2019-04-05 21:02:07 -07:00
streaming_compression.c [examples] Clean up and comment the examples 2019-04-05 21:02:07 -07:00
streaming_decompression.c [examples] Clean up and comment the examples 2019-04-05 21:02:07 -07:00
streaming_memory_usage.c [examples] Clean up and comment the examples 2019-04-05 21:02:07 -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()