27 lines
8.3 KiB
HTML
27 lines
8.3 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="Rust binding to the zstd library."><meta name="keywords" content="rust, rustlang, rust-lang, zstd"><title>zstd - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
|
||
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">☰</div><a class="sidebar-logo" href="../zstd/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.png" alt="logo"></div>
|
||
</a><h2 class="location">Crate zstd</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.10.0+zstd.1.5.2</p></div><div class="sidebar-elems"><a id="all-types" href="all.html"><p>See all zstd's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#constants">Constants</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="zstd" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../zstd/index.html"><img class="rust-logo" src="../rust-logo.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">zstd</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></span><span class="out-of-band"><span id="render-detail"><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span><a class="srclink" href="../src/zstd/lib.rs.html#1-78" title="goto source code">[src]</a></span></h1><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Rust binding to the <a href="https://github.com/facebook/zstd">zstd library</a>.</p>
|
||
<p>This crate provides:</p>
|
||
<ul>
|
||
<li>An <a href="stream/write/struct.Encoder.html">encoder</a> to compress data using zstd
|
||
and send the output to another write.</li>
|
||
<li>A <a href="stream/read/struct.Decoder.html">decoder</a> to read input data from a <code>Read</code>
|
||
and decompress it.</li>
|
||
<li>Convenient functions for common tasks.</li>
|
||
</ul>
|
||
<h2 id="example" class="section-header"><a href="#example">Example</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use</span> <span class="ident">std::io</span>;
|
||
|
||
<span class="comment">// Uncompress input and print the result.</span>
|
||
<span class="ident">zstd::stream::copy_decode</span>(<span class="ident">io::stdin</span>(), <span class="ident">io::stdout</span>()).<span class="ident">unwrap</span>();</code></pre></div>
|
||
</div></details><h2 id="reexports" class="small-section-header"><a href="#reexports">Re-exports</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left import-item"><code>pub use <a class="mod" href="../zstd_safe/index.html" title="mod zstd_safe">zstd_safe</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use crate::stream::<a class="fn" href="stream/fn.decode_all.html" title="fn zstd::stream::decode_all">decode_all</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use crate::stream::<a class="fn" href="stream/fn.encode_all.html" title="fn zstd::stream::encode_all">encode_all</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use crate::stream::<a class="struct" href="stream/read/struct.Decoder.html" title="struct zstd::stream::read::Decoder">Decoder</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use crate::stream::<a class="struct" href="stream/write/struct.Encoder.html" title="struct zstd::stream::write::Encoder">Encoder</a>;</code></div><div class="item-right docblock-short"></div></div></div><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="bulk/index.html" title="zstd::bulk mod">bulk</a></div><div class="item-right docblock-short"><p>Compress and decompress data in bulk.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="dict/index.html" title="zstd::dict mod">dict</a></div><div class="item-right docblock-short"><p>Train a dictionary from various sources.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="stream/index.html" title="zstd::stream mod">stream</a></div><div class="item-right docblock-short"><p>Compress and decompress Zstd streams.</p>
|
||
</div></div></div><h2 id="constants" class="small-section-header"><a href="#constants">Constants</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="constant" href="constant.DEFAULT_COMPRESSION_LEVEL.html" title="zstd::DEFAULT_COMPRESSION_LEVEL constant">DEFAULT_COMPRESSION_LEVEL</a></div><div class="item-right docblock-short"><p>Default compression level.</p>
|
||
</div></div></div><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
|
||
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.compression_level_range.html" title="zstd::compression_level_range fn">compression_level_range</a></div><div class="item-right docblock-short"><p>The accepted range of compression levels.</p>
|
||
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="zstd" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.59.0 (9d1b2106e 2022-02-23)" ></div>
|
||
</body></html> |