78 lines
38 KiB
HTML
78 lines
38 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="Allows to compress independently multiple chunks of data."><title>Compressor in zstd::bulk - 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 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="#">Compressor</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="#">Compressor</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.compress_to_buffer" title="compress_to_buffer">compress_to_buffer</a></li><li><a href="#method.context_mut" title="context_mut">context_mut</a></li><li><a href="#method.include_checksum" title="include_checksum">include_checksum</a></li><li><a href="#method.include_contentsize" title="include_contentsize">include_contentsize</a></li><li><a href="#method.include_dictid" title="include_dictid">include_dictid</a></li><li><a href="#method.long_distance_matching" title="long_distance_matching">long_distance_matching</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.set_compression_level" title="set_compression_level">set_compression_level</a></li><li><a href="#method.set_dictionary" title="set_dictionary">set_dictionary</a></li><li><a href="#method.set_parameter" title="set_parameter">set_parameter</a></li><li><a href="#method.set_prepared_dictionary" title="set_prepared_dictionary">set_prepared_dictionary</a></li><li><a href="#method.set_target_cblock_size" title="set_target_cblock_size">set_target_cblock_size</a></li><li><a href="#method.window_log" title="window_log">window_log</a></li><li><a href="#method.with_dictionary" title="with_dictionary">with_dictionary</a></li><li><a href="#method.with_prepared_dictionary" title="with_prepared_dictionary">with_prepared_dictionary</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Default-for-Compressor%3C'a%3E" title="Default">Default</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-Compressor%3C'a%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-Compressor%3C'a%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Compressor%3C'a%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-Compressor%3C'a%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-Compressor%3C'a%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Compressor%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<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In zstd::<wbr>bulk</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">bulk</a></div><h1>Struct <span class="struct">Compressor</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/bulk/compressor.rs.html#16-18">Source</a> </span></div><pre class="rust item-decl"><code>pub struct Compressor<'a> { <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>Allows to compress independently multiple chunks of data.</p>
|
||
<p>Each job will be processed entirely in-memory without streaming, so this
|
||
is most fitting for many small jobs. To compress larger volume that don’t
|
||
easily fit in memory, a streaming compression may be more appropriate.</p>
|
||
<p>It is more efficient than a streaming compressor for 2 reasons:</p>
|
||
<ul>
|
||
<li>It re-uses the zstd context between jobs to avoid re-allocations</li>
|
||
<li>It avoids copying data from a <code>Read</code> into a temporary buffer before compression.</li>
|
||
</ul>
|
||
</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-Compressor%3C'static%3E" class="impl"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#20-37">Source</a><a href="#impl-Compressor%3C'static%3E" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'static></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#22-24">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>(level: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i32.html">i32</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><Self></h4></section></summary><div class="docblock"><p>Creates a new zstd compressor</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_dictionary" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#30-36">Source</a><h4 class="code-header">pub fn <a href="#method.with_dictionary" class="fn">with_dictionary</a>(level: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i32.html">i32</a>, dictionary: &[<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><Self></h4></section></summary><div class="docblock"><p>Creates a new zstd compressor, using the given dictionary.</p>
|
||
<p>Note that using a dictionary means that decompression will need to use
|
||
the same dictionary.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Compressor%3C'a%3E" class="impl"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#39-158">Source</a><a href="#impl-Compressor%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <a class="struct" href="struct.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_prepared_dictionary" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#46-57">Source</a><h4 class="code-header">pub fn <a href="#method.with_prepared_dictionary" class="fn">with_prepared_dictionary</a><'b>(
|
||
dictionary: &'a <a class="struct" href="../dict/struct.EncoderDictionary.html" title="struct zstd::dict::EncoderDictionary">EncoderDictionary</a><'b>,
|
||
) -> <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><Self><div class="where">where
|
||
'b: 'a,</div></h4></section></summary><div class="docblock"><p>Creates a new compressor using an existing <code>EncoderDictionary</code>.</p>
|
||
<p>The compression level will be the one specified when creating the dictionary.</p>
|
||
<p>Note that using a dictionary means that decompression will need to use
|
||
the same dictionary.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_compression_level" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#65-67">Source</a><h4 class="code-header">pub fn <a href="#method.set_compression_level" class="fn">set_compression_level</a>(&mut self, level: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i32.html">i32</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.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Changes the compression level used by this compressor.</p>
|
||
<p><em>This will clear any dictionary previously registered.</em></p>
|
||
<p>If you want to keep the existing dictionary, you will need to pass it again to
|
||
<code>Self::set_dictionary</code> instead of using this method.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_dictionary" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#75-89">Source</a><h4 class="code-header">pub fn <a href="#method.set_dictionary" class="fn">set_dictionary</a>(&mut self, level: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.i32.html">i32</a>, dictionary: &[<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="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Changes the dictionary and compression level used by this compressor.</p>
|
||
<p>Will affect future compression jobs.</p>
|
||
<p>Note that using a dictionary means that decompression will need to use
|
||
the same dictionary.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_prepared_dictionary" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#97-109">Source</a><h4 class="code-header">pub fn <a href="#method.set_prepared_dictionary" class="fn">set_prepared_dictionary</a><'b>(
|
||
&mut self,
|
||
dictionary: &'a <a class="struct" href="../dict/struct.EncoderDictionary.html" title="struct zstd::dict::EncoderDictionary">EncoderDictionary</a><'b>,
|
||
) -> <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>><div class="where">where
|
||
'b: 'a,</div></h4></section></summary><div class="docblock"><p>Changes the dictionary used by this compressor.</p>
|
||
<p>The compression level used when preparing the dictionary will be used.</p>
|
||
<p>Note that using a dictionary means that decompression will need to use
|
||
the same dictionary.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.compress_to_buffer" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#117-125">Source</a><h4 class="code-header">pub fn <a href="#method.compress_to_buffer" class="fn">compress_to_buffer</a><C: <a class="trait" href="../stream/raw/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,
|
||
source: &[<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>],
|
||
destination: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&mut C</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>Compress a single block of data to the given destination buffer.</p>
|
||
<p>Returns the number of bytes written, or an error if something happened
|
||
(for instance if the destination buffer was too small).</p>
|
||
<p>A level of <code>0</code> uses zstd’s default (currently <code>3</code>).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.compress" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#130-139">Source</a><h4 class="code-header">pub fn <a href="#method.compress" class="fn">compress</a>(&mut self, data: &[<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="https://doc.rust-lang.org/1.93.1/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>>></h4></section></summary><div class="docblock"><p>Compresses a block of data and returns the compressed result.</p>
|
||
<p>A level of <code>0</code> uses zstd’s default (currently <code>3</code>).</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.context_mut" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#142-144">Source</a><h4 class="code-header">pub fn <a href="#method.context_mut" class="fn">context_mut</a>(&mut self) -> &mut <a class="struct" href="../../zstd_safe/struct.CCtx.html" title="struct zstd_safe::CCtx">CCtx</a><'a></h4></section></summary><div class="docblock"><p>Gives mutable access to the internal context.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_parameter" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#147-155">Source</a><h4 class="code-header">pub fn <a href="#method.set_parameter" class="fn">set_parameter</a>(&mut self, parameter: <a class="enum" href="../stream/raw/enum.CParameter.html" title="enum zstd::stream::raw::CParameter">CParameter</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.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Sets a compression parameter for this compressor.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.include_checksum" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#157">Source</a><h4 class="code-header">pub fn <a href="#method.include_checksum" class="fn">include_checksum</a>(&mut self, include_checksum: <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.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Controls whether zstd should include a content checksum at the end
|
||
of each frame.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.include_dictid" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#157">Source</a><h4 class="code-header">pub fn <a href="#method.include_dictid" class="fn">include_dictid</a>(&mut self, include_dictid: <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.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Enables or disables storing of the dict id.</p>
|
||
<p>Defaults to true. If false, the behaviour of decoding with a wrong
|
||
dictionary is undefined.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.include_contentsize" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#157">Source</a><h4 class="code-header">pub fn <a href="#method.include_contentsize" class="fn">include_contentsize</a>(&mut self, include_contentsize: <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.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Enables or disabled storing of the contentsize.</p>
|
||
<p>Note that this only has an effect if the size is given with <code>set_pledged_src_size</code>.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.long_distance_matching" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#157">Source</a><h4 class="code-header">pub fn <a href="#method.long_distance_matching" class="fn">long_distance_matching</a>(
|
||
&mut self,
|
||
long_distance_matching: <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.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Enables or disables long-distance matching</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.set_target_cblock_size" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#157">Source</a><h4 class="code-header">pub fn <a href="#method.set_target_cblock_size" class="fn">set_target_cblock_size</a>(&mut self, target_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><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</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.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Sets the target size for compressed blocks.</p>
|
||
<p>A lower block size may result in slightly lower speed (~2%) and compression ratio
|
||
(~0.1%), but may decrease end-to-end latency in low-bandwidth environments (time to
|
||
first decompressed byte).</p>
|
||
<p>No value, or a value of zero, results in no contraint for the block sizes.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.window_log" class="method"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#157">Source</a><h4 class="code-header">pub fn <a href="#method.window_log" class="fn">window_log</a>(&mut self, log_distance: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</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.unit.html">()</a>></h4></section></summary><div class="docblock"><p>Sets the maximum back-reference distance.</p>
|
||
<p>The actual maximum distance is going to be <code>2^log_distance</code>.</p>
|
||
<p>Note that decompression will need to use at least the same setting.</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-Compressor%3C'a%3E" class="impl"><a class="src rightside" href="../../src/zstd/bulk/compressor.rs.html#15">Source</a><a href="#impl-Default-for-Compressor%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <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.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'a></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/bulk/compressor.rs.html#15">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>() -> <a class="struct" href="struct.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'a></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></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-Compressor%3C'a%3E" class="impl"><a href="#impl-Freeze-for-Compressor%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <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.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'a></h3></section><section id="impl-RefUnwindSafe-for-Compressor%3C'a%3E" class="impl"><a href="#impl-RefUnwindSafe-for-Compressor%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <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.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'a></h3></section><section id="impl-Send-for-Compressor%3C'a%3E" class="impl"><a href="#impl-Send-for-Compressor%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <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.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'a></h3></section><section id="impl-Sync-for-Compressor%3C'a%3E" class="impl"><a href="#impl-Sync-for-Compressor%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <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.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'a></h3></section><section id="impl-Unpin-for-Compressor%3C'a%3E" class="impl"><a href="#impl-Unpin-for-Compressor%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <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.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'a></h3></section><section id="impl-UnwindSafe-for-Compressor%3C'a%3E" class="impl"><a href="#impl-UnwindSafe-for-Compressor%3C'a%3E" class="anchor">§</a><h3 class="code-header">impl<'a> <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.Compressor.html" title="struct zstd::bulk::Compressor">Compressor</a><'a></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<T> <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>(&self) -> <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<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> 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>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&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<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> 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>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&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<T> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> 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) -> 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<T, 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><U> 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><T>,</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) -> 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><T> 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<T, 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><U> 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><T>,</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) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <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><U>>::<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'>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<T, U> <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> 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><T>,</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> = <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><T>>::<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) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <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><T>>::<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'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |