20 lines
8.2 KiB
HTML
20 lines
8.2 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="Compress and decompress Zstd streams."><meta name="keywords" content="rust, rustlang, rust-lang, stream"><title>zstd::stream - 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"><!--[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">Module stream</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="stream" 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">Module <a href="../index.html">zstd</a>::<wbr><a class="mod" href="#">stream</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/stream/mod.rs.html#1-219" 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>Compress and decompress Zstd streams.</p>
|
||
<p>Zstd streams are the main way to compress and decompress data.
|
||
They are compatible with the <code>zstd</code> command-line tool.</p>
|
||
<p>This module provides both <code>Read</code> and <code>Write</code> interfaces to compressing and
|
||
decompressing.</p>
|
||
</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 self::read::<a class="struct" href="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 self::write::<a class="struct" href="write/struct.AutoFinishEncoder.html" title="struct zstd::stream::write::AutoFinishEncoder">AutoFinishEncoder</a>;</code></div><div class="item-right docblock-short"></div></div><div class="item-row"><div class="item-left import-item"><code>pub use self::write::<a class="struct" href="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="raw/index.html" title="zstd::stream::raw mod">raw</a></div><div class="item-right docblock-short"><p>Raw in-memory stream compression/decompression.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="read/index.html" title="zstd::stream::read mod">read</a></div><div class="item-right docblock-short"><p>Implement pull-based <a href="https://doc.rust-lang.org/1.59.0/std/io/trait.Read.html" title="Read"><code>Read</code></a> trait for both compressing and decompressing.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="write/index.html" title="zstd::stream::write mod">write</a></div><div class="item-right docblock-short"><p>Implement push-based <a href="https://doc.rust-lang.org/1.59.0/std/io/trait.Write.html" title="Write"><code>Write</code></a> trait for both compressing and decompressing.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="zio/index.html" title="zstd::stream::zio mod">zio</a></div><div class="item-right docblock-short"><p>Wrappers around raw operations implementing <code>std::io::{Read, Write}</code>.</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.copy_decode.html" title="zstd::stream::copy_decode fn">copy_decode</a></div><div class="item-right docblock-short"><p>Decompress from the given source as if using a <code>Decoder</code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.copy_encode.html" title="zstd::stream::copy_encode fn">copy_encode</a></div><div class="item-right docblock-short"><p>Compress all data from the given source as if using an <code>Encoder</code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.decode_all.html" title="zstd::stream::decode_all fn">decode_all</a></div><div class="item-right docblock-short"><p>Decompress from the given source as if using a <code>Decoder</code>.</p>
|
||
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.encode_all.html" title="zstd::stream::encode_all fn">encode_all</a></div><div class="item-right docblock-short"><p>Compress all data from the given source as if using an <code>Encoder</code>.</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> |