| <!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="Decoder is a raw decoder for decompressing bytes in the Snappy format."><meta name="keywords" content="rust, rustlang, rust-lang, Decoder"><title>Decoder in snap - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../normalize.css"><link rel="stylesheet" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../ayu.css" disabled><link rel="stylesheet" href="../dark.css" disabled><link rel="stylesheet" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../snap/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../snap/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Decoder</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.decompress">decompress</a></li><li><a href="#method.decompress_vec">decompress_vec</a></li><li><a href="#method.new">new</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-Decoder">Clone</a></li><li><a href="#impl-Debug-for-Decoder">Debug</a></li><li><a href="#impl-Default-for-Decoder">Default</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-Decoder">RefUnwindSafe</a></li><li><a href="#impl-Send-for-Decoder">Send</a></li><li><a href="#impl-Sync-for-Decoder">Sync</a></li><li><a href="#impl-Unpin-for-Decoder">Unpin</a></li><li><a href="#impl-UnwindSafe-for-Decoder">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-Decoder">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-Decoder">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-Decoder">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-Decoder">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-Decoder">Into<U></a></li><li><a href="#impl-ToOwned-for-Decoder">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-Decoder">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-Decoder">TryInto<U></a></li></ul></section><h2><a href="index.html">In snap</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="index.html">snap</a>::<wbr><a class="struct" href="#">Decoder</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/snap/decompress.rs.html#47-50">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct Decoder { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Decoder is a raw decoder for decompressing bytes in the Snappy format.</p> |
| <p>This decoder does not use the Snappy frame format and simply decompresses |
| the given bytes as if it were returned from <code>Encoder</code>.</p> |
| <p>Unless you explicitly need the low-level control, you should use |
| <code>Reader</code> instead, which decompresses the Snappy frame format.</p> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Decoder" class="impl has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#52-116">source</a><a href="#impl-Decoder" class="anchor"></a><h3 class="code-header">impl <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#54-56">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h4></section></summary><div class="docblock"><p>Return a new decoder that can be used for decompressing bytes.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.decompress" class="method has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#76-100">source</a><h4 class="code-header">pub fn <a href="#method.decompress" class="fnname">decompress</a>(&mut self, input: &[u8], output: &mut [u8]) -> <a class="type" href="type.Result.html" title="type snap::Result">Result</a><usize></h4></section></summary><div class="docblock"><p>Decompresses all bytes in <code>input</code> into <code>output</code>.</p> |
| <p><code>input</code> must be a sequence of bytes returned by a conforming Snappy |
| compressor.</p> |
| <p>The size of <code>output</code> must be large enough to hold all decompressed |
| bytes from the <code>input</code>. The size required can be queried with the |
| <code>decompress_len</code> function.</p> |
| <p>On success, this returns the number of bytes written to <code>output</code>.</p> |
| <h5 id="errors"><a href="#errors">Errors</a></h5> |
| <p>This method returns an error in the following circumstances:</p> |
| <ul> |
| <li>Invalid compressed Snappy data was seen.</li> |
| <li>The total space required for decompression exceeds <code>2^32 - 1</code>.</li> |
| <li><code>output</code> has length less than <code>decompress_len(input)</code>.</li> |
| </ul> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.decompress_vec" class="method has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#110-115">source</a><h4 class="code-header">pub fn <a href="#method.decompress_vec" class="fnname">decompress_vec</a>(&mut self, input: &[u8]) -> <a class="type" href="type.Result.html" title="type snap::Result">Result</a><Vec<u8>></h4></section></summary><div class="docblock"><p>Decompresses all bytes in <code>input</code> into a freshly allocated <code>Vec</code>.</p> |
| <p>This is just like the <code>decompress</code> method, except it allocates a <code>Vec</code> |
| with the right size for you. (This is intended to be a convenience |
| method.)</p> |
| <p>This method returns an error under the same circumstances that |
| <code>decompress</code> does.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-Decoder" class="impl has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#46">source</a><a href="#impl-Clone-for-Decoder" class="anchor"></a><h3 class="code-header">impl Clone for <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#46">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone</a>(&self) -> <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const fn <a class="fnname">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-Decoder" class="impl has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#46">source</a><a href="#impl-Debug-for-Decoder" class="anchor"></a><h3 class="code-header">impl Debug for <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#46">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-Decoder" class="impl has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#46">source</a><a href="#impl-Default-for-Decoder" class="anchor"></a><h3 class="code-header">impl Default for <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../src/snap/decompress.rs.html#46">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a class="fnname">default</a>() -> <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-Decoder" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-Decoder" class="anchor"></a><h3 class="code-header">impl RefUnwindSafe for <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h3></section><section id="impl-Send-for-Decoder" class="impl has-srclink"><a href="#impl-Send-for-Decoder" class="anchor"></a><h3 class="code-header">impl Send for <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h3></section><section id="impl-Sync-for-Decoder" class="impl has-srclink"><a href="#impl-Sync-for-Decoder" class="anchor"></a><h3 class="code-header">impl Sync for <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h3></section><section id="impl-Unpin-for-Decoder" class="impl has-srclink"><a href="#impl-Unpin-for-Decoder" class="anchor"></a><h3 class="code-header">impl Unpin for <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h3></section><section id="impl-UnwindSafe-for-Decoder" class="impl has-srclink"><a href="#impl-UnwindSafe-for-Decoder" class="anchor"></a><h3 class="code-header">impl UnwindSafe for <a class="struct" href="struct.Decoder.html" title="struct snap::Decoder">Decoder</a></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-Decoder" class="impl has-srclink"><a href="#impl-Any-for-Decoder" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-Decoder" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-Decoder" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-Decoder" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-Decoder" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-Decoder" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-Decoder" class="anchor"></a><h3 class="code-header">impl<T> From<T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-Decoder" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-Decoder" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">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>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-Decoder" class="impl has-srclink"><a href="#impl-ToOwned-for-Decoder" class="anchor"></a><h3 class="code-header">impl<T> ToOwned for T<span class="where fmt-newline">where<br> T: Clone,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a>Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">clone_into</a>(&self, target: &mut T)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-Decoder" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-Decoder" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-Decoder" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-Decoder" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="snap" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
