summaryrefslogtreecommitdiff
path: root/src/third_party/zstandard-1.3.7/zstd/examples/README.md
diff options
context:
space:
mode:
authorHenrik Edin <henrik.edin@mongodb.com>2018-12-05 14:11:38 -0500
committerHenrik Edin <henrik.edin@mongodb.com>2018-12-11 12:02:44 -0500
commitd525ae91e64209267fdaedc17a2542f61b638849 (patch)
treea3fc55e5e202e3dbea2aa15635c8d4f3b20c6fd1 /src/third_party/zstandard-1.3.7/zstd/examples/README.md
parentbc035c247827fbda8df43f5df6bb075da234179d (diff)
downloadmongo-d525ae91e64209267fdaedc17a2542f61b638849.tar.gz
SERVER-38168 Vendor Zstandard 1.3.7 to third_party
Added a Zstd based message compressor.
Diffstat (limited to 'src/third_party/zstandard-1.3.7/zstd/examples/README.md')
-rw-r--r--src/third_party/zstandard-1.3.7/zstd/examples/README.md40
1 files changed, 40 insertions, 0 deletions
diff --git a/src/third_party/zstandard-1.3.7/zstd/examples/README.md b/src/third_party/zstandard-1.3.7/zstd/examples/README.md
new file mode 100644
index 00000000000..eba50c9997d
--- /dev/null
+++ b/src/third_party/zstandard-1.3.7/zstd/examples/README.md
@@ -0,0 +1,40 @@
+Zstandard library : usage examples
+==================================
+
+- [Simple compression](simple_compression.c) :
+ Compress a single file.
+ Introduces usage of : `ZSTD_compress()`
+
+- [Simple decompression](simple_decompression.c) :
+ Decompress a single file.
+ Only compatible with simple compression.
+ Result remains in memory.
+ Introduces usage of : `ZSTD_decompress()`
+
+- [Streaming memory usage](streaming_memory_usage.c) :
+ Provides amount of memory used by streaming context
+ Introduces usage of : `ZSTD_sizeof_CStream()`
+
+- [Streaming compression](streaming_compression.c) :
+ Compress a single file.
+ Introduces usage of : `ZSTD_compressStream()`
+
+- [Multiple Streaming compression](multiple_streaming_compression.c) :
+ Compress multiple files in a single command line.
+ Introduces memory usage preservation technique,
+ reducing impact of malloc()/free() and memset() by re-using existing resources.
+
+- [Streaming decompression](streaming_decompression.c) :
+ 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](dictionary_compression.c) :
+ Compress multiple files using the same dictionary.
+ Introduces usage of : `ZSTD_createCDict()` and `ZSTD_compress_usingCDict()`
+
+- [Dictionary decompression](dictionary_decompression.c) :
+ Decompress multiple files using the same dictionary.
+ Result remains in memory.
+ Introduces usage of : `ZSTD_createDDict()` and `ZSTD_decompress_usingDDict()`