This repository has been archived on 2022-04-04. You can view files and clone it, but cannot push or open issues or pull requests.

21 lines
7.7 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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="Raw in-memory stream compression&#x2F;decompression."><meta name="keywords" content="rust, rustlang, rust-lang, raw"><title>zstd::stream::raw - 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">&#9776;</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 raw</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><div id="sidebar-vars" data-name="raw" 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 href="../index.html">stream</a>::<wbr><a class="mod" href="#">raw</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">&#x2212;</span>]</a></span><a class="srclink" href="../../../src/zstd/stream/raw.rs.html#1-353" 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>Raw in-memory stream compression/decompression.</p>
<p>This module defines a <code>Decoder</code> and an <code>Encoder</code> to decode/encode streams
of data using buffers.</p>
<p>They are mostly thin wrappers around <code>zstd_safe::{DCtx, CCtx}</code>.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Decoder.html" title="zstd::stream::raw::Decoder struct">Decoder</a></div><div class="item-right docblock-short"><p>An in-memory decoder for streams of data.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Encoder.html" title="zstd::stream::raw::Encoder struct">Encoder</a></div><div class="item-right docblock-short"><p>An in-memory encoder for streams of data.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.InBuffer.html" title="zstd::stream::raw::InBuffer struct">InBuffer</a></div><div class="item-right docblock-short"><p>Wrapper around an input buffer.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.NoOp.html" title="zstd::stream::raw::NoOp struct">NoOp</a></div><div class="item-right docblock-short"><p>Dummy operation that just copies its input to the output.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OutBuffer.html" title="zstd::stream::raw::OutBuffer struct">OutBuffer</a></div><div class="item-right docblock-short"><p>Wrapper around an output buffer.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Status.html" title="zstd::stream::raw::Status struct">Status</a></div><div class="item-right docblock-short"><p>Describes the result of an operation.</p>
</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.CParameter.html" title="zstd::stream::raw::CParameter enum">CParameter</a></div><div class="item-right docblock-short"><p>A compression parameter.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.DParameter.html" title="zstd::stream::raw::DParameter enum">DParameter</a></div><div class="item-right docblock-short"><p>A decompression parameter.</p>
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.Operation.html" title="zstd::stream::raw::Operation trait">Operation</a></div><div class="item-right docblock-short"><p>Represents an abstract compression/decompression operation.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.WriteBuf.html" title="zstd::stream::raw::WriteBuf trait">WriteBuf</a></div><div class="item-right docblock-short"><p>Describe a resizeable bytes container like <code>Vec&lt;u8&gt;</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>