hobokenchicken/GopherGate
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity
Files
87a3ecba070727671c0bdf79408b23e9dfdf10cc
GopherGate/target/doc/zstd_safe/struct.CCtx.html
hobokenchicken 49701c85ad Adding large folders
2026-02-26 12:00:21 -05:00

119 lines
42 KiB
HTML
Raw Blame History

<!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="Compression context"><title>CCtx in zstd_safe - 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_safe" 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 struct"><!--[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="#">CCtx</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../zstd_safe/index.html">zstd_<wbr>safe</a><span class="version">7.2.4</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">CCtx</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.compress" title="compress">compress</a></li><li><a href="#method.compress2" title="compress2">compress2</a></li><li><a href="#method.compress_stream" title="compress_stream">compress_stream</a></li><li><a href="#method.compress_stream2" title="compress_stream2">compress_stream2</a></li><li><a href="#method.compress_using_cdict" title="compress_using_cdict">compress_using_cdict</a></li><li><a href="#method.compress_using_dict" title="compress_using_dict">compress_using_dict</a></li><li><a href="#method.create" title="create">create</a></li><li><a href="#method.disable_dictionary" title="disable_dictionary">disable_dictionary</a></li><li><a href="#method.end_stream" title="end_stream">end_stream</a></li><li><a href="#method.flush_stream" title="flush_stream">flush_stream</a></li><li><a href="#method.in_size" title="in_size">in_size</a></li><li><a href="#method.init" title="init">init</a></li><li><a href="#method.load_dictionary" title="load_dictionary">load_dictionary</a></li><li><a href="#method.out_size" title="out_size">out_size</a></li><li><a href="#method.ref_cdict" title="ref_cdict">ref_cdict</a></li><li><a href="#method.ref_prefix" title="ref_prefix">ref_prefix</a></li><li><a href="#method.reset" title="reset">reset</a></li><li><a href="#method.set_parameter" title="set_parameter">set_parameter</a></li><li><a href="#method.set_pledged_src_size" title="set_pledged_src_size">set_pledged_src_size</a></li><li><a href="#method.sizeof" title="sizeof">sizeof</a></li><li><a href="#method.try_create" title="try_create">try_create</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Default-for-CCtx%3C'_%3E" title="Default">Default</a></li><li><a href="#impl-Drop-for-CCtx%3C'a%3E" title="Drop">Drop</a></li><li><a href="#impl-Send-for-CCtx%3C'_%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-CCtx%3C'_%3E" title="Sync">Sync</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-CCtx%3C'a%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-CCtx%3C'a%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Unpin-for-CCtx%3C'a%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-CCtx%3C'a%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow&#60;T&#62;">Borrow&#60;T&#62;</a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut&#60;T&#62;">BorrowMut&#60;T&#62;</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From&#60;T&#62;">From&#60;T&#62;</a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into&#60;U&#62;">Into&#60;U&#62;</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom&#60;U&#62;">TryFrom&#60;U&#62;</a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto&#60;U&#62;">TryInto&#60;U&#62;</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate zstd_<wbr>safe</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_safe</a></div><h1>Struct <span class="struct">CCtx</span>&nbsp;<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_safe/lib.rs.html#227">Source</a> </span></div><pre class="rust item-decl"><code>pub struct CCtx&lt;'a&gt;(<span class="comment">/* private fields */</span>);</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Compression context</p>
<p>It is recommended to allocate a single context per thread and re-use it
for many compression operations.</p>
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-CCtx%3C'a%3E" class="impl"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#235-857">Source</a><a href="#impl-CCtx%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="struct" href="struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a>&lt;'a&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.try_create" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#239-245">Source</a><h4 class="code-header">pub fn <a href="#method.try_create" class="fn">try_create</a>() -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;Self&gt;</h4></section></summary><div class="docblock"><p>Tries to create a new context.</p>
<p>Returns <code>None</code> if zstd returns a NULL pointer - may happen if allocation fails.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.create" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#252-255">Source</a><h4 class="code-header">pub fn <a href="#method.create" class="fn">create</a>() -&gt; Self</h4></section></summary><div class="docblock"><p>Wrap <code>ZSTD_createCCtx</code></p>
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
<p>If zstd returns a NULL pointer.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.compress" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#258-277">Source</a><h4 class="code-header">pub fn <a href="#method.compress" class="fn">compress</a>&lt;C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd_safe::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>&gt;(
&amp;mut self,
dst: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;mut C</a>,
src: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
compression_level: <a class="type" href="type.CompressionLevel.html" title="type zstd_safe::CompressionLevel">CompressionLevel</a>,
) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Wraps the <code>ZSTD_compressCCtx()</code> function</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.compress2" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#280-297">Source</a><h4 class="code-header">pub fn <a href="#method.compress2" class="fn">compress2</a>&lt;C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd_safe::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>&gt;(
&amp;mut self,
dst: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;mut C</a>,
src: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Wraps the <code>ZSTD_compress2()</code> function.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.compress_using_dict" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#300-322">Source</a><h4 class="code-header">pub fn <a href="#method.compress_using_dict" class="fn">compress_using_dict</a>&lt;C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd_safe::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>&gt;(
&amp;mut self,
dst: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;mut C</a>,
src: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
dict: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
compression_level: <a class="type" href="type.CompressionLevel.html" title="type zstd_safe::CompressionLevel">CompressionLevel</a>,
) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Wraps the <code>ZSTD_compress_usingDict()</code> function.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.compress_using_cdict" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#325-344">Source</a><h4 class="code-header">pub fn <a href="#method.compress_using_cdict" class="fn">compress_using_cdict</a>&lt;C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd_safe::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>&gt;(
&amp;mut self,
dst: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;mut C</a>,
src: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
cdict: &amp;<a class="struct" href="struct.CDict.html" title="struct zstd_safe::CDict">CDict</a>&lt;'_&gt;,
) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Wraps the <code>ZSTD_compress_usingCDict()</code> function.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.init" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#351-357">Source</a><h4 class="code-header">pub fn <a href="#method.init" class="fn">init</a>(&amp;mut self, compression_level: <a class="type" href="type.CompressionLevel.html" title="type zstd_safe::CompressionLevel">CompressionLevel</a>) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Initializes the context with the given compression level.</p>
<p>This is equivalent to running:</p>
<ul>
<li><code>reset()</code></li>
<li><code>set_parameter(CompressionLevel, compression_level)</code></li>
</ul>
</div></details><details class="toggle method-toggle" open><summary><section id="method.load_dictionary" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#427-436">Source</a><h4 class="code-header">pub fn <a href="#method.load_dictionary" class="fn">load_dictionary</a>(&amp;mut self, dict: &amp;[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Tries to load a dictionary.</p>
<p>The dictionary content will be copied internally and does not need to be kept alive after
calling this function.</p>
<p>If you need to use the same dictionary for multiple contexts, it may be more efficient to
create a <code>CDict</code> first, then loads that.</p>
<p>The dictionary will apply to all compressed frames, until a new dictionary is set.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.ref_cdict" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#441-449">Source</a><h4 class="code-header">pub fn <a href="#method.ref_cdict" class="fn">ref_cdict</a>&lt;'b&gt;(&amp;mut self, cdict: &amp;<a class="struct" href="struct.CDict.html" title="struct zstd_safe::CDict">CDict</a>&lt;'b&gt;) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a><div class="where">where
'b: 'a,</div></h4></section></summary><div class="docblock"><p>Wraps the <code>ZSTD_CCtx_refCDict()</code> function.</p>
<p>Dictionary must outlive the context.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.disable_dictionary" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#454-463">Source</a><h4 class="code-header">pub fn <a href="#method.disable_dictionary" class="fn">disable_dictionary</a>(&amp;mut self) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Return to “no-dictionary” mode.</p>
<p>This will disable any dictionary/prefix previously registered for future frames.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.ref_prefix" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#470-482">Source</a><h4 class="code-header">pub fn <a href="#method.ref_prefix" class="fn">ref_prefix</a>&lt;'b&gt;(&amp;mut self, prefix: &amp;'b [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a><div class="where">where
'b: 'a,</div></h4></section></summary><div class="docblock"><p>Use some prefix as single-use dictionary for the next compressed frame.</p>
<p>Just like a dictionary, decompression will need to be given the same prefix.</p>
<p>This is best used if the “prefix” looks like the data to be compressed.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.compress_stream" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#495-511">Source</a><h4 class="code-header">pub fn <a href="#method.compress_stream" class="fn">compress_stream</a>&lt;C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd_safe::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>&gt;(
&amp;mut self,
output: &amp;mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd_safe::OutBuffer">OutBuffer</a>&lt;'_, C&gt;,
input: &amp;mut <a class="struct" href="struct.InBuffer.html" title="struct zstd_safe::InBuffer">InBuffer</a>&lt;'_&gt;,
) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Performs a step of a streaming compression operation.</p>
<p>This will read some data from <code>input</code> and/or write some data to <code>output</code>.</p>
<h5 id="returns"><a class="doc-anchor" href="#returns">§</a>Returns</h5>
<p>A hint for the “ideal” amount of input data to provide in the next call.</p>
<p>This hint is only for performance purposes.</p>
<p>Wraps the <code>ZSTD_compressStream()</code> function.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.compress_stream2" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#528-545">Source</a><h4 class="code-header">pub fn <a href="#method.compress_stream2" class="fn">compress_stream2</a>&lt;C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd_safe::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>&gt;(
&amp;mut self,
output: &amp;mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd_safe::OutBuffer">OutBuffer</a>&lt;'_, C&gt;,
input: &amp;mut <a class="struct" href="struct.InBuffer.html" title="struct zstd_safe::InBuffer">InBuffer</a>&lt;'_&gt;,
end_op: <a class="enum" href="../zstd_sys/enum.ZSTD_EndDirective.html" title="enum zstd_sys::ZSTD_EndDirective">ZSTD_EndDirective</a>,
) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Performs a step of a streaming compression operation.</p>
<p>This will read some data from <code>input</code> and/or write some data to <code>output</code>.</p>
<p>The <code>end_op</code> directive can be used to specify what to do after: nothing special, flush
internal buffers, or end the frame.</p>
<h5 id="returns-1"><a class="doc-anchor" href="#returns-1">§</a>Returns</h5>
<p>An lower bound for the amount of data that still needs to be flushed out.</p>
<p>This is useful when flushing or ending the frame: you need to keep calling this function
until it returns 0.</p>
<p>Wraps the <code>ZSTD_compressStream2()</code> function.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.flush_stream" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#552-562">Source</a><h4 class="code-header">pub fn <a href="#method.flush_stream" class="fn">flush_stream</a>&lt;C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd_safe::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>&gt;(
&amp;mut self,
output: &amp;mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd_safe::OutBuffer">OutBuffer</a>&lt;'_, C&gt;,
) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Flush any intermediate buffer.</p>
<p>To fully flush, you should keep calling this function until it returns <code>Ok(0)</code>.</p>
<p>Wraps the <code>ZSTD_flushStream()</code> function.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.end_stream" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#569-579">Source</a><h4 class="code-header">pub fn <a href="#method.end_stream" class="fn">end_stream</a>&lt;C: <a class="trait" href="trait.WriteBuf.html" title="trait zstd_safe::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>&gt;(
&amp;mut self,
output: &amp;mut <a class="struct" href="struct.OutBuffer.html" title="struct zstd_safe::OutBuffer">OutBuffer</a>&lt;'_, C&gt;,
) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Ends the stream.</p>
<p>You should keep calling this function until it returns <code>Ok(0)</code>.</p>
<p>Wraps the <code>ZSTD_endStream()</code> function.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.sizeof" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#584-587">Source</a><h4 class="code-header">pub fn <a href="#method.sizeof" class="fn">sizeof</a>(&amp;self) -&gt; <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>Returns the size currently used by this context.</p>
<p>This may change over time.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.reset" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#594-599">Source</a><h4 class="code-header">pub fn <a href="#method.reset" class="fn">reset</a>(&amp;mut self, reset: <a class="enum" href="enum.ResetDirective.html" title="enum zstd_safe::ResetDirective">ResetDirective</a>) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Resets the state of the context.</p>
<p>Depending on the reset mode, it can reset the session, the parameters, or both.</p>
<p>Wraps the <code>ZSTD_CCtx_reset()</code> function.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_parameter" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#604-724">Source</a><h4 class="code-header">pub fn <a href="#method.set_parameter" class="fn">set_parameter</a>(&amp;mut self, param: <a class="enum" href="enum.CParameter.html" title="enum zstd_safe::CParameter">CParameter</a>) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Sets a compression parameter.</p>
<p>Some of these parameters need to be set during de-compression as well.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_pledged_src_size" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#734-745">Source</a><h4 class="code-header">pub fn <a href="#method.set_pledged_src_size" class="fn">set_pledged_src_size</a>(
&amp;mut self,
pledged_src_size: <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u64.html">u64</a>&gt;,
) -&gt; <a class="type" href="type.SafeResult.html" title="type zstd_safe::SafeResult">SafeResult</a></h4></section></summary><div class="docblock"><p>Guarantee that the input size will be this value.</p>
<p>If given <code>None</code>, assumes the size is unknown.</p>
<p>Unless explicitly disabled, this will cause the size to be written in the compressed frame
header.</p>
<p>If the actual data given to compress has a different size, an error will be returned.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.in_size" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#806-809">Source</a><h4 class="code-header">pub fn <a href="#method.in_size" class="fn">in_size</a>() -&gt; <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>Returns the recommended input buffer size.</p>
<p>Using this size may result in minor performance boost.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.out_size" class="method"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#814-817">Source</a><h4 class="code-header">pub fn <a href="#method.out_size" class="fn">out_size</a>() -&gt; <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>Returns the recommended output buffer size.</p>
<p>Using this may result in minor performance boost.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-CCtx%3C'_%3E" class="impl"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#229-233">Source</a><a href="#impl-Default-for-CCtx%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a>&lt;'_&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#230-232">Source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -&gt; Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.93.1/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Drop-for-CCtx%3C'a%3E" class="impl"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#859-866">Source</a><a href="#impl-Drop-for-CCtx%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a>&lt;'a&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#860-865">Source</a><a href="#method.drop" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/ops/drop/trait.Drop.html#tymethod.drop" class="fn">drop</a>(&amp;mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/1.93.1/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details><section id="impl-Send-for-CCtx%3C'_%3E" class="impl"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#868">Source</a><a href="#impl-Send-for-CCtx%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a>&lt;'_&gt;</h3></section><section id="impl-Sync-for-CCtx%3C'_%3E" class="impl"><a class="src rightside" href="../src/zstd_safe/lib.rs.html#870">Source</a><a href="#impl-Sync-for-CCtx%3C'_%3E" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a>&lt;'_&gt;</h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-CCtx%3C'a%3E" class="impl"><a href="#impl-Freeze-for-CCtx%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a>&lt;'a&gt;</h3></section><section id="impl-RefUnwindSafe-for-CCtx%3C'a%3E" class="impl"><a href="#impl-RefUnwindSafe-for-CCtx%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a>&lt;'a&gt;</h3></section><section id="impl-Unpin-for-CCtx%3C'a%3E" class="impl"><a href="#impl-Unpin-for-CCtx%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a>&lt;'a&gt;</h3></section><section id="impl-UnwindSafe-for-CCtx%3C'a%3E" class="impl"><a href="#impl-UnwindSafe-for-CCtx%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a>&lt;'a&gt;</h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.93.1/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.93.1/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#212">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#214">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#221">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/borrow.rs.html#222">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#785">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#788">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#767-769">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#777">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#827-829">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#831">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#834">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#811-813">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#815">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.93.1/src/core/convert/mod.rs.html#818">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html>
Reference in New Issue View Git Blame Copy Permalink