mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
14 lines
14 KiB
HTML
14 lines
14 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 `Decoder` struct in crate `gif`."><meta name="keywords" content="rust, rustlang, rust-lang, Decoder"><title>gif::Decoder - 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 Decoder</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.read_info">read_info</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Parameter%3CDecoder%3CR%3E%3E">Parameter<Decoder<R>></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: 'Decoder', 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=''>Decoder</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/mod.rs.html#63-68' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Decoder<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> { /* fields omitted */ }</pre></div><div class='docblock'><p>GIF decoder</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<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> <a class="struct" href="../gif/struct.Decoder.html" title="struct gif::Decoder">Decoder</a><R></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/mod.rs.html#70-87' 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>(r: R) -> <a class="struct" href="../gif/struct.Decoder.html" title="struct gif::Decoder">Decoder</a><R></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#72-79' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates a new decoder builder</p>
|
||
</div><h4 id='method.read_info' class="method"><span id='read_info.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_info' class='fnname'>read_info</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../gif/struct.Reader.html" title="struct gif::Reader">Reader</a><R>, <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/mod.rs.html#84-86' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Reads the logical screen descriptor including the global color palette</p>
|
||
<p>Returns a <code>Reader</code>. All decoder configuration has to be done beforehand.</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%3CDecoder%3CR%3E%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<T, R> <a class="trait" href="../gif/trait.Parameter.html" title="trait gif::Parameter">Parameter</a><<a class="struct" href="../gif/struct.Decoder.html" title="struct gif::Decoder">Decoder</a><R>> for T <span class="where fmt-newline">where<br> T: <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>>,<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>, </span></code><a href='#impl-Parameter%3CDecoder%3CR%3E%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#19-26' 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.Decoder.html" title="struct gif::Decoder">Decoder</a><R>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#22-24' 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-Parameter%3CDecoder%3CR%3E%3E-1' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> <a class="trait" href="../gif/trait.Parameter.html" title="trait gif::Parameter">Parameter</a><<a class="struct" href="../gif/struct.Decoder.html" title="struct gif::Decoder">Decoder</a><R>> for <a class="enum" href="../gif/enum.ColorOutput.html" title="enum gif::ColorOutput">ColorOutput</a></code><a href='#impl-Parameter%3CDecoder%3CR%3E%3E-1' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#42-47' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Result-1' class="type"><span id='Result.t-1' 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-1' class="method"><span id='set_param.v-1' 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.Decoder.html" title="struct gif::Decoder">Decoder</a><R>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#44-46' 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-Parameter%3CDecoder%3CR%3E%3E-2' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> <a class="trait" href="../gif/trait.Parameter.html" title="trait gif::Parameter">Parameter</a><<a class="struct" href="../gif/struct.Decoder.html" title="struct gif::Decoder">Decoder</a><R>> for <a class="struct" href="../gif/struct.MemoryLimit.html" title="struct gif::MemoryLimit">MemoryLimit</a></code><a href='#impl-Parameter%3CDecoder%3CR%3E%3E-2' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#54-60' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='associatedtype.Result-2' class="type"><span id='Result.t-2' 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-2' class="method"><span id='set_param.v-2' 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.Decoder.html" title="struct gif::Decoder">Decoder</a><R>)</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#56-59' 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></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<R> <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.Decoder.html" title="struct gif::Decoder">Decoder</a><R> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></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<R> <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.Decoder.html" title="struct gif::Decoder">Decoder</a><R> <span class="where fmt-newline">where<br> R: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></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> |