From fd38af62dc0a981e133e7dd03f13999651eccdb5 Mon Sep 17 00:00:00 2001 From: Nigel Tao Date: Tue, 26 Nov 2019 20:52:11 +1100 Subject: [PATCH] Add doc/std/compression-decoders.md --- doc/std/compression-decoders.md | 41 +++++++++++++++++++++++++++++++++ 1 file changed, 41 insertions(+) create mode 100644 doc/std/compression-decoders.md diff --git a/doc/std/compression-decoders.md b/doc/std/compression-decoders.md new file mode 100644 index 00000000..8695546f --- /dev/null +++ b/doc/std/compression-decoders.md @@ -0,0 +1,41 @@ +# Compression Decoders + +Compression decoders read from one input stream (an `io_reader` called `src`) +and write to an output stream (an `io_writer` called `dst`). Wuffs' +implementations have one key method: `decode_io_writer`, named after the +operation (decoding) and the type of the destination (an +[`io_writer`](/doc/note/io-input-output.md)). It incrementally decompresses the +source data. + +This method is a [coroutine](/doc/note/coroutines.md), and does not require +either all of the input or all of the output to fit in a single contiguous +buffer. It can suspend with the `$short_read` or `$short_write` +[statuses](/doc/note/statuses.md) when the `src` buffer needs re-filling or the +`dst` buffer needs flushing. For an example, look at the +[example/zcat](/example/zcat/zcat.c) program, which uses fixed size buffers, +but reads arbitrarily long compressed input from stdin and writes arbitrarily +long decompressed output to stdout. + + +## Dictionaries + +TODO: standardize the various dictionary APIs, after Wuffs v0.2 is released. + + +## Implementations + +- [std/deflate](/std/deflate) +- [std/gzip](/std/gzip) +- [std/lzw](/std/lzw) +- [std/zlib](/std/zlib) + + +## Examples + +- [example/library](/example/library) +- [example/zcat](/example/zcat) + + +--- + +See also the general remarks on [Wuffs' standard library](/doc/std/README.md).