6 lines
6.0 KiB
HTML
6 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="Compress and decompress Zstd streams."><title>zstd::stream - 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 stream</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 stream</a></h2><h3><a href="#reexports">Module 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="#functions" title="Functions">Functions</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>stream</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/stream/mod.rs.html#1-227">Source</a> </span></div><details class="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="section-header">Re-exports<a href="#reexports" class="anchor">§</a></h2><dl class="item-table reexports"><dt id="reexport.Decoder"><code>pub use self::read::<a class="struct" href="read/struct.Decoder.html" title="struct zstd::stream::read::Decoder">Decoder</a>;</code></dt><dt id="reexport.AutoFinishEncoder"><code>pub use self::write::<a class="struct" href="write/struct.AutoFinishEncoder.html" title="struct zstd::stream::write::AutoFinishEncoder">AutoFinishEncoder</a>;</code></dt><dt id="reexport.Encoder"><code>pub use self::write::<a class="struct" href="write/struct.Encoder.html" title="struct zstd::stream::write::Encoder">Encoder</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="raw/index.html" title="mod zstd::stream::raw">raw</a></dt><dd>Raw in-memory stream compression/decompression.</dd><dt><a class="mod" href="read/index.html" title="mod zstd::stream::read">read</a></dt><dd>Implement pull-based <a href="https://doc.rust-lang.org/1.93.1/std/io/trait.Read.html" title="trait std::io::Read"><code>Read</code></a> trait for both compressing and decompressing.</dd><dt><a class="mod" href="write/index.html" title="mod zstd::stream::write">write</a></dt><dd>Implement push-based <a href="https://doc.rust-lang.org/1.93.1/std/io/trait.Write.html" title="trait std::io::Write"><code>Write</code></a> trait for both compressing and decompressing.</dd><dt><a class="mod" href="zio/index.html" title="mod zstd::stream::zio">zio</a></dt><dd>Wrappers around raw operations implementing <code>std::io::{Read, Write}</code>.</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.copy_decode.html" title="fn zstd::stream::copy_decode">copy_<wbr>decode</a></dt><dd>Decompress from the given source as if using a <code>Decoder</code>.</dd><dt><a class="fn" href="fn.copy_encode.html" title="fn zstd::stream::copy_encode">copy_<wbr>encode</a></dt><dd>Compress all data from the given source as if using an <code>Encoder</code>.</dd><dt><a class="fn" href="fn.decode_all.html" title="fn zstd::stream::decode_all">decode_<wbr>all</a></dt><dd>Decompress from the given source as if using a <code>Decoder</code>.</dd><dt><a class="fn" href="fn.encode_all.html" title="fn zstd::stream::encode_all">encode_<wbr>all</a></dt><dd>Compress all data from the given source as if using an <code>Encoder</code>.</dd></dl></section></div></main></body></html> |