mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
15 lines
15 KiB
HTML
15 lines
15 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `StreamingDecoder` struct in crate `gif`."><meta name="keywords" content="rust, rustlang, rust-lang, StreamingDecoder"><title>gif::StreamingDecoder - 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 StreamingDecoder</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.update">update</a><a href="#method.last_ext">last_ext</a><a href="#method.current_frame_mut">current_frame_mut</a><a href="#method.current_frame">current_frame</a><a href="#method.width">width</a><a href="#method.height">height</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Parameter%3CStreamingDecoder%3E">Parameter<StreamingDecoder></a><a href="#impl-Debug">Debug</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'>gif</a></p><script>window.sidebarCurrent = {name: 'StreamingDecoder', 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'>gif</a>::<wbr><a class="struct" href=''>StreamingDecoder</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/gif/reader/decoder.rs.html#164-177' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct StreamingDecoder { /* fields omitted */ }</pre></div><div class='docblock'><p>GIF decoder which supports streaming</p>
|
||
</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="../gif/struct.StreamingDecoder.html" title="struct gif::StreamingDecoder">StreamingDecoder</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/gif/reader/decoder.rs.html#179-562' 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="../gif/struct.StreamingDecoder.html" title="struct gif::StreamingDecoder">StreamingDecoder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#181-194' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new streaming decoder</p>
|
||
</div><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> buf: <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="enum" href="../gif/enum.Decoded.html" title="enum gif::Decoded">Decoded</a><'a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../gif/enum.DecodingError.html" title="enum gif::DecodingError">DecodingError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#200-237' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Updates the internal state of the decoder.</p>
|
||
<p>Returns the number of bytes consumed from the input buffer
|
||
and the last decoding result.</p>
|
||
</div><h4 id='method.last_ext' class="method"><span id='last_ext.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.last_ext' class='fnname'>last_ext</a>(&self) -> <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.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.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.bool.html">bool</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#240-242' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the data of the last extension that has been decoded.</p>
|
||
</div><h4 id='method.current_frame_mut' class="method"><span id='current_frame_mut.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.current_frame_mut' class='fnname'>current_frame_mut</a><'a>(&'a mut self) -> &'a mut <a class="struct" href="../gif/struct.Frame.html" title="struct gif::Frame">Frame</a><'static></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#246-248' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Current frame info as a mutable ref.</p>
|
||
</div><h4 id='method.current_frame' class="method"><span id='current_frame.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.current_frame' class='fnname'>current_frame</a><'a>(&'a self) -> &'a <a class="struct" href="../gif/struct.Frame.html" title="struct gif::Frame">Frame</a><'static></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#252-254' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Current frame info as a ref.</p>
|
||
</div><h4 id='method.width' class="method"><span id='width.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.width' class='fnname'>width</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#257-259' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Width of the image</p>
|
||
</div><h4 id='method.height' class="method"><span id='height.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.height' class='fnname'>height</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u16.html">u16</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#262-264' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Height of the image</p>
|
||
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Parameter%3CStreamingDecoder%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="../gif/trait.Parameter.html" title="trait gif::Parameter">Parameter</a><<a class="struct" href="../gif/struct.StreamingDecoder.html" title="struct gif::StreamingDecoder">StreamingDecoder</a>> for <a class="enum" href="../gif/enum.Extensions.html" title="enum gif::Extensions">Extensions</a></code><a href='#impl-Parameter%3CStreamingDecoder%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#73-82' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Result' class="type"><span id='Result.t' class='invisible'><code>type <a href='../gif/trait.Parameter.html#associatedtype.Result' class="type">Result</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a></code></span></h4>
|
||
<div class='docblock'><p>Result type of <code>set_param</code>.</p>
|
||
</div><h4 id='method.set_param' class="method"><span id='set_param.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='../gif/trait.Parameter.html#tymethod.set_param' class='fnname'>set_param</a>(self, this: &mut <a class="struct" href="../gif/struct.StreamingDecoder.html" title="struct gif::StreamingDecoder">StreamingDecoder</a>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#75-81' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Sets <code>self</code> as a parameter of <code>Object</code>.</p>
|
||
</div></div><h3 id='impl-Debug' 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/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../gif/struct.StreamingDecoder.html" title="struct gif::StreamingDecoder">StreamingDecoder</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#163' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/decoder.rs.html#163' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
</div></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="../gif/struct.StreamingDecoder.html" title="struct gif::StreamingDecoder">StreamingDecoder</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="../gif/struct.StreamingDecoder.html" title="struct gif::StreamingDecoder">StreamingDecoder</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 = "gif";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |