54 lines
15 KiB
HTML
54 lines
15 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."><title>Operation in zstd::stream::raw - 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 trait"><!--[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="#">Operation</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="#">Operation</a></h2><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.run" title="run">run</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.finish" title="finish">finish</a></li><li><a href="#method.flush" title="flush">flush</a></li><li><a href="#method.reinit" title="reinit">reinit</a></li><li><a href="#method.run_on_buffers" title="run_on_buffers">run_on_buffers</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In zstd::<wbr>stream::<wbr>raw</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>::<wbr><a href="../index.html">stream</a>::<wbr><a href="index.html">raw</a></div><h1>Trait <span class="trait">Operation</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/raw.rs.html#17-85">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Operation {
|
||
// Required method
|
||
fn <a href="#tymethod.run" class="fn">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.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(
|
||
&mut self,
|
||
input: &mut <a class="struct" href="struct.InBuffer.html" title="struct zstd::stream::raw::InBuffer">InBuffer</a><'_>,
|
||
output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C>,
|
||
) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>>;
|
||
|
||
// Provided methods
|
||
fn <a href="#method.run_on_buffers" class="fn">run_on_buffers</a>(
|
||
&mut self,
|
||
input: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
output: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/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>> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.flush" class="fn">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.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(
|
||
&mut self,
|
||
output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C>,
|
||
) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.reinit" class="fn">reinit</a>(&mut self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>> { ... }
|
||
<span class="item-spacer"></span> fn <a href="#method.finish" class="fn">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.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(
|
||
&mut self,
|
||
output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C>,
|
||
finished_frame: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a>,
|
||
) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>> { ... }
|
||
}</code></pre><details class="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="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.run" class="method"><a class="src rightside" href="../../../src/zstd/stream/raw.rs.html#24-28">Source</a><h4 class="code-header">fn <a href="#tymethod.run" class="fn">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.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(
|
||
&mut self,
|
||
input: &mut <a class="struct" href="struct.InBuffer.html" title="struct zstd::stream::raw::InBuffer">InBuffer</a><'_>,
|
||
output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C>,
|
||
) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>></h4></section></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="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.run_on_buffers" class="method"><a class="src rightside" href="../../../src/zstd/stream/raw.rs.html#34-49">Source</a><h4 class="code-header">fn <a href="#method.run_on_buffers" class="fn">run_on_buffers</a>(&mut self, input: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>], output: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/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></section></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="toggle method-toggle" open><summary><section id="method.flush" class="method"><a class="src rightside" href="../../../src/zstd/stream/raw.rs.html#55-61">Source</a><h4 class="code-header">fn <a href="#method.flush" class="fn">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.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(
|
||
&mut self,
|
||
output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C>,
|
||
) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>></h4></section></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="toggle method-toggle" open><summary><section id="method.reinit" class="method"><a class="src rightside" href="../../../src/zstd/stream/raw.rs.html#66-68">Source</a><h4 class="code-header">fn <a href="#method.reinit" class="fn">reinit</a>(&mut self) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>></h4></section></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="toggle method-toggle" open><summary><section id="method.finish" class="method"><a class="src rightside" href="../../../src/zstd/stream/raw.rs.html#76-84">Source</a><h4 class="code-header">fn <a href="#method.finish" class="fn">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.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(
|
||
&mut self,
|
||
output: &mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd::stream::raw::OutBuffer">OutBuffer</a><'_, C>,
|
||
finished_frame: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a>,
|
||
) -> <a class="type" href="https://doc.rust-lang.org/1.93.1/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>></h4></section></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="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><section id="impl-Operation-for-Decoder%3C'_%3E" class="impl"><a class="src rightside" href="../../../src/zstd/stream/raw.rs.html#204-261">Source</a><a href="#impl-Operation-for-Decoder%3C'_%3E" class="anchor">§</a><h3 class="code-header">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></section><section id="impl-Operation-for-NoOp" class="impl"><a class="src rightside" href="../../../src/zstd/stream/raw.rs.html#90-115">Source</a><a href="#impl-Operation-for-NoOp" class="anchor">§</a><h3 class="code-header">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></section><section id="impl-Operation-for-Encoder%3C'a%3E" class="impl"><a class="src rightside" href="../../../src/zstd/stream/raw.rs.html#372-420">Source</a><a href="#impl-Operation-for-Encoder%3C'a%3E" class="anchor">§</a><h3 class="code-header">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></section></div><script src="../../../trait.impl/zstd/stream/raw/trait.Operation.js" async></script></section></div></main></body></html> |