10 lines
4.5 KiB
HTML
10 lines
4.5 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Train a dictionary from various sources."><title>zstd::dict - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="zstd" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="../sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">Module dict</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../zstd/index.html">zstd</a><span class="version">0.13.3</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Module dict</a></h2><h3><a href="#structs">Module Items</a></h3><ul class="block"><li><a href="#structs" title="Structs">Structs</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="../index.html">In crate zstd</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">zstd</a></div><h1>Module <span>dict</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/zstd/dict.rs.html#1-296">Source</a> </span></div><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Train a dictionary from various sources.</p>
|
|
<p>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.</p>
|
|
<p>Creating a dictionary using the <code>zstd</code> C library,
|
|
using the <code>zstd</code> command-line interface, using this library,
|
|
or using the <code>train</code> binary provided, should give the same result,
|
|
and are therefore completely compatible.</p>
|
|
<p>To use, see <a href="../struct.Encoder.html#method.with_dictionary"><code>Encoder::with_dictionary</code></a> or <a href="../struct.Decoder.html#method.with_dictionary"><code>Decoder::with_dictionary</code></a>.</p>
|
|
</div></details><h2 id="structs" class="section-header">Structs<a href="#structs" class="anchor">§</a></h2><dl class="item-table"><dt><a class="struct" href="struct.CDict.html" title="struct zstd::dict::CDict">CDict</a></dt><dd>Compression dictionary.</dd><dt><a class="struct" href="struct.DDict.html" title="struct zstd::dict::DDict">DDict</a></dt><dd>A digested decompression dictionary.</dd><dt><a class="struct" href="struct.DecoderDictionary.html" title="struct zstd::dict::DecoderDictionary">Decoder<wbr>Dictionary</a></dt><dd>Prepared dictionary for decompression</dd><dt><a class="struct" href="struct.EncoderDictionary.html" title="struct zstd::dict::EncoderDictionary">Encoder<wbr>Dictionary</a></dt><dd>Prepared dictionary for compression</dd></dl></section></div></main></body></html> |