14 lines
6.0 KiB
HTML
14 lines
6.0 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."><title>zstd - 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="../crates.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 crate"><!--[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="#">Crate zstd</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"><ul class="block"><li><a id="all-types" href="all.html">All Items</a></li></ul><section id="rustdoc-toc"><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#example" title="Example">Example</a></li></ul><h3><a href="#reexports">Crate Items</a></h3><ul class="block"><li><a href="#reexports" title="Re-exports">Re-exports</a></li><li><a href="#modules" title="Modules">Modules</a></li><li><a href="#constants" title="Constants">Constants</a></li><li><a href="#functions" title="Functions">Functions</a></li></ul></section><div id="rustdoc-modnav"></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"><h1>Crate <span>zstd</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/lib.rs.html#1-78">Source</a> </span></div><details class="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"><a class="doc-anchor" href="#example">§</a>Example</h2>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::io;
|
|
|
|
<span class="comment">// Uncompress input and print the result.
|
|
</span>zstd::stream::copy_decode(io::stdin(), io::stdout()).unwrap();</code></pre></div></div></details><h2 id="reexports" class="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.decode_all"><code>pub use crate::stream::<a class="fn" href="stream/fn.decode_all.html" title="fn zstd::stream::decode_all">decode_all</a>;</code></dt><dt id="reexport.encode_all"><code>pub use crate::stream::<a class="fn" href="stream/fn.encode_all.html" title="fn zstd::stream::encode_all">encode_all</a>;</code></dt><dt id="reexport.Decoder"><code>pub use crate::stream::<a class="struct" href="stream/read/struct.Decoder.html" title="struct zstd::stream::read::Decoder">Decoder</a>;</code></dt><dt id="reexport.Encoder"><code>pub use crate::stream::<a class="struct" href="stream/write/struct.Encoder.html" title="struct zstd::stream::write::Encoder">Encoder</a>;</code></dt><dt id="reexport.zstd_safe"><code>pub use <a class="mod" href="../zstd_safe/index.html" title="mod zstd_safe">zstd_safe</a>;</code></dt></dl><h2 id="modules" class="section-header">Modules<a href="#modules" class="anchor">§</a></h2><dl class="item-table"><dt><a class="mod" href="bulk/index.html" title="mod zstd::bulk">bulk</a></dt><dd>Compress and decompress data in bulk.</dd><dt><a class="mod" href="dict/index.html" title="mod zstd::dict">dict</a></dt><dd>Train a dictionary from various sources.</dd><dt><a class="mod" href="stream/index.html" title="mod zstd::stream">stream</a></dt><dd>Compress and decompress Zstd streams.</dd></dl><h2 id="constants" class="section-header">Constants<a href="#constants" class="anchor">§</a></h2><dl class="item-table"><dt><a class="constant" href="constant.DEFAULT_COMPRESSION_LEVEL.html" title="constant zstd::DEFAULT_COMPRESSION_LEVEL">DEFAULT_<wbr>COMPRESSION_<wbr>LEVEL</a></dt><dd>Default compression level.</dd></dl><h2 id="functions" class="section-header">Functions<a href="#functions" class="anchor">§</a></h2><dl class="item-table"><dt><a class="fn" href="fn.compression_level_range.html" title="fn zstd::compression_level_range">compression_<wbr>level_<wbr>range</a></dt><dd>The accepted range of compression levels.</dd></dl></section></div></main></body></html> |