29 lines
18 KiB
HTML
29 lines
18 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="Represents an abstract compression/decompression operation."><meta name="keywords" content="rust, rustlang, rust-lang, Operation"><title>Operation in 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 trait"><!--[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">Trait Operation</h2><div class="sidebar-elems"><div class="block items"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><div class="sidebar-links"><a href="#tymethod.run">run</a></div><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><div class="sidebar-links"><a href="#method.finish">finish</a><a href="#method.flush">flush</a><a href="#method.reinit">reinit</a><a href="#method.run_on_buffers">run_on_buffers</a></div><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div><h2 class="location">Other items in<br><a href="../../index.html">zstd</a>::<wbr><a href="../index.html">stream</a>::<wbr><a href="index.html">raw</a></h2><div id="sidebar-vars" data-name="Operation" data-ty="trait" 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">Trait <a href="../../index.html">zstd</a>::<wbr><a href="../index.html">stream</a>::<wbr><a href="index.html">raw</a>::<wbr><a class="trait" href="#">Operation</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/raw.rs.html#17-85" title="goto source code">[src]</a></span></h1><div class="docblock item-decl"><pre class="rust trait"><code>pub trait Operation {
|
||
fn <a href="#tymethod.run" class="fnname">run</a><C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd::stream::raw::WriteBuf">WriteBuf</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &mut self, <br> input: &mut <a class="struct" href="struct.InBuffer.html" title="struct zstd::stream::raw::InBuffer">InBuffer</a><'_>, <br> output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C><br> ) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>>;
|
||
|
||
fn <a href="#method.run_on_buffers" class="fnname">run_on_buffers</a>(<br> &mut self, <br> input: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>, <br> output: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a><br> ) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.Status.html" title="struct zstd::stream::raw::Status">Status</a>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.flush" class="fnname">flush</a><C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd::stream::raw::WriteBuf">WriteBuf</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &mut self, <br> output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C><br> ) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.reinit" class="fnname">reinit</a>(&mut self) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.unit.html">()</a>> { ... }
|
||
<div class="item-spacer"></div> fn <a href="#method.finish" class="fnname">finish</a><C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd::stream::raw::WriteBuf">WriteBuf</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &mut self, <br> output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C>, <br> finished_frame: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.bool.html">bool</a><br> ) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>> { ... }
|
||
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Represents an abstract compression/decompression operation.</p>
|
||
<p>This trait covers both <code>Encoder</code> and <code>Decoder</code>.</p>
|
||
</div></details><h2 id="required-methods" class="small-section-header">Required methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.run" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/zstd/stream/raw.rs.html#24-28" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#tymethod.run" class="fnname">run</a><C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd::stream::raw::WriteBuf">WriteBuf</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &mut self, <br> input: &mut <a class="struct" href="struct.InBuffer.html" title="struct zstd::stream::raw::InBuffer">InBuffer</a><'_>, <br> output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C><br>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>></h4></div></summary><div class="docblock"><p>Performs a single step of this operation.</p>
|
||
<p>Should return a hint for the next input size.</p>
|
||
<p>If the result is <code>Ok(0)</code>, it may indicate that a frame was just
|
||
finished.</p>
|
||
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.run_on_buffers" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/zstd/stream/raw.rs.html#34-49" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.run_on_buffers" class="fnname">run_on_buffers</a>(&mut self, input: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>, output: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">&mut [</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.slice.html">]</a>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="struct" href="struct.Status.html" title="struct zstd::stream::raw::Status">Status</a>></h4></div></summary><div class="docblock"><p>Performs a single step of this operation.</p>
|
||
<p>This is a comvenience wrapper around <code>Operation::run</code> if you don’t
|
||
want to deal with <code>InBuffer</code>/<code>OutBuffer</code>.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.flush" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/zstd/stream/raw.rs.html#55-61" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.flush" class="fnname">flush</a><C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd::stream::raw::WriteBuf">WriteBuf</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &mut self, <br> output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C><br>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>></h4></div></summary><div class="docblock"><p>Flushes any internal buffer, if any.</p>
|
||
<p>Returns the number of bytes still in the buffer.
|
||
To flush entirely, keep calling until it returns <code>Ok(0)</code>.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.reinit" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/zstd/stream/raw.rs.html#66-68" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.reinit" class="fnname">reinit</a>(&mut self) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.unit.html">()</a>></h4></div></summary><div class="docblock"><p>Prepares the operation for a new frame.</p>
|
||
<p>This is hopefully cheaper than creating a new operation.</p>
|
||
</div></details><details class="rustdoc-toggle" open><summary><div id="method.finish" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../../src/zstd/stream/raw.rs.html#76-84" title="goto source code">[src]</a></div><h4 class="code-header">fn <a href="#method.finish" class="fnname">finish</a><C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd::stream::raw::WriteBuf">WriteBuf</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.59.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &mut self, <br> output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C>, <br> finished_frame: <a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.bool.html">bool</a><br>) -> <a class="type" href="https://doc.rust-lang.org/1.59.0/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.59.0/std/primitive.usize.html">usize</a>></h4></div></summary><div class="docblock"><p>Finishes the operation, writing any footer if necessary.</p>
|
||
<p>Returns the number of bytes still to write.</p>
|
||
<p>Keep calling this method until it returns <code>Ok(0)</code>,
|
||
and then don’t ever call this method.</p>
|
||
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><div id="impl-Operation" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/zstd/stream/raw.rs.html#176-206" title="goto source code">[src]</a></div><a href="#impl-Operation" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Operation.html" title="trait zstd::stream::raw::Operation">Operation</a> for <a class="struct" href="struct.Decoder.html" title="struct zstd::stream::raw::Decoder">Decoder</a><'_></h3></div><div id="impl-Operation-1" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/zstd/stream/raw.rs.html#90-114" title="goto source code">[src]</a></div><a href="#impl-Operation-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.Operation.html" title="trait zstd::stream::raw::Operation">Operation</a> for <a class="struct" href="struct.NoOp.html" title="struct zstd::stream::raw::NoOp">NoOp</a></h3></div><div id="impl-Operation-2" class="impl has-srclink"><div class="rightside"><a class="srclink" href="../../../src/zstd/stream/raw.rs.html#275-307" title="goto source code">[src]</a></div><a href="#impl-Operation-2" class="anchor"></a><h3 class="code-header in-band">impl<'a> <a class="trait" href="trait.Operation.html" title="trait zstd::stream::raw::Operation">Operation</a> for <a class="struct" href="struct.Encoder.html" title="struct zstd::stream::raw::Encoder">Encoder</a><'a></h3></div></div><script type="text/javascript" src="../../../implementors/zstd/stream/raw/trait.Operation.js" async></script></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> |