Module zstd::dict

Train a dictionary from various sources.

A dictionary can help improve the compression of small files. The dictionary must be present during decompression, but can be shared across multiple “similar” files.

Creating a dictionary using the zstd C library, using the zstd command-line interface, using this library, or using the train binary provided, should give the same result, and are therefore completely compatible.

To use, see Encoder::with_dictionary or Decoder::with_dictionary.

Structs

• CDict
  Compression dictionary.
• DDict
  A digested decompression dictionary.
• DecoderDictionary
  Prepared dictionary for decompression
• EncoderDictionary
  Prepared dictionary for compression

Functions

• from_continuous
  Train a dictionary from a big continuous chunk of data, with all samples contiguous in memory.
• from_files
  Train a dict from a list of files.
• from_sample_iterator
  Train a dictionary from multiple samples.
• from_samples
  Train a dictionary from multiple samples.