mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 02:58:23 +00:00
17 lines
12 KiB
HTML
17 lines
12 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="API documentation for the Rust `InflateStream` struct in crate `inflate`."><meta name="keywords" content="rust, rustlang, rust-lang, InflateStream"><title>inflate::InflateStream - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Struct InflateStream</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.from_zlib">from_zlib</a><a href="#method.from_zlib_no_checksum">from_zlib_no_checksum</a><a href="#method.reset">reset</a><a href="#method.reset_to_zlib">reset_to_zlib</a><a href="#method.update">update</a><a href="#method.current_checksum">current_checksum</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div></div><p class='location'><a href='index.html'>inflate</a></p><script>window.sidebarCurrent = {name: 'InflateStream', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>inflate</a>::<wbr><a class="struct" href=''>InflateStream</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/inflate/lib.rs.html#552-559' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct InflateStream { /* fields omitted */ }</pre></div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../inflate/struct.InflateStream.html" title="struct inflate::InflateStream">InflateStream</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/inflate/lib.rs.html#561-1035' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../inflate/struct.InflateStream.html" title="struct inflate::InflateStream">InflateStream</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/inflate/lib.rs.html#564-568' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new stream for decoding raw deflate encoded data.</p>
|
||
</div><h4 id='method.from_zlib' class="method"><span id='from_zlib.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.from_zlib' class='fnname'>from_zlib</a>() -> <a class="struct" href="../inflate/struct.InflateStream.html" title="struct inflate::InflateStream">InflateStream</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/inflate/lib.rs.html#571-573' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new stream for decoding deflate encoded data with a zlib header and footer</p>
|
||
</div><h4 id='method.from_zlib_no_checksum' class="method"><span id='from_zlib_no_checksum.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.from_zlib_no_checksum' class='fnname'>from_zlib_no_checksum</a>() -> <a class="struct" href="../inflate/struct.InflateStream.html" title="struct inflate::InflateStream">InflateStream</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/inflate/lib.rs.html#579-581' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new stream for decoding deflate encoded data with a zlib header and footer</p>
|
||
<p>This version creates a decoder that does not checksum the data to validate it with the
|
||
checksum provided with the zlib wrapper.</p>
|
||
</div><h4 id='method.reset' class="method"><span id='reset.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.reset' class='fnname'>reset</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/inflate/lib.rs.html#583-588' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.reset_to_zlib' class="method"><span id='reset_to_zlib.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.reset_to_zlib' class='fnname'>reset_to_zlib</a>(&mut self)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/inflate/lib.rs.html#590-593' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><h4 id='method.update' class="method"><span id='update.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.update' class='fnname'>update</a><'a>(<br> &'a mut self, <br> data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><br>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/inflate/lib.rs.html#999-1027' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Try to uncompress/decode the data in <code>data</code>.</p>
|
||
<p>On success, returns how many bytes of the input data was decompressed, and a reference to
|
||
the buffer containing the decompressed data.</p>
|
||
<p>This function may not uncompress all the provided data in one call, so it has to be called
|
||
repeatedly with the data that hasn't been decompressed yet as an input until the number of
|
||
bytes decoded returned is 0. (See the <a href="index.html">top level crate documentation</a>
|
||
for an example.)</p>
|
||
<h1 id="errors" class="section-header"><a href="#errors">Errors</a></h1>
|
||
<p>If invalid input data is encountered, a string describing what went wrong is returned.</p>
|
||
</div><h4 id='method.current_checksum' class="method"><span id='current_checksum.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.current_checksum' class='fnname'>current_checksum</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/inflate/lib.rs.html#1032-1034' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the calculated checksum value of the currently decoded data.</p>
|
||
<p>Will return 0 for cases where the checksum is not validated.</p>
|
||
</div></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'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../inflate/struct.InflateStream.html" title="struct inflate::InflateStream">InflateStream</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../inflate/struct.InflateStream.html" title="struct inflate::InflateStream">InflateStream</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "inflate";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |