mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
27 lines
13 KiB
HTML
27 lines
13 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 `Decoded` enum in crate `gif`."><meta name="keywords" content="rust, rustlang, rust-lang, Decoded"><title>gif::Decoded - 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 enum"><!--[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'>Enum Decoded</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#variants">Variants</a><div class="sidebar-links"><a href="#variant.Nothing">Nothing</a><a href="#variant.GlobalPalette">GlobalPalette</a><a href="#variant.BackgroundColor">BackgroundColor</a><a href="#variant.Trailer">Trailer</a><a href="#variant.BlockStart">BlockStart</a><a href="#variant.SubBlockFinished">SubBlockFinished</a><a href="#variant.BlockFinished">BlockFinished</a><a href="#variant.Frame">Frame</a><a href="#variant.Data">Data</a><a href="#variant.DataEnd">DataEnd</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><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: 'Decoded', ty: 'enum', 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'>Enum <a href='index.html'>gif</a>::<wbr><a class="enum" href=''>Decoded</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#86-109' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust enum'>pub enum Decoded<'a> {
|
||
Nothing,
|
||
GlobalPalette(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>),
|
||
BackgroundColor(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>),
|
||
Trailer,
|
||
BlockStart(<a class="enum" href="../gif/enum.Block.html" title="enum gif::Block">Block</a>),
|
||
SubBlockFinished(<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><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>),
|
||
BlockFinished(<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><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>),
|
||
Frame(&'a <a class="struct" href="../gif/struct.Frame.html" title="struct gif::Frame">Frame</a><'static>),
|
||
Data(<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>),
|
||
DataEnd,
|
||
}</pre></div><div class='docblock'><p>Indicates whether a certain object has been decoded</p>
|
||
</div><h2 id='variants' class='variants small-section-header'>
|
||
Variants<a href='#variants' class='anchor'></a></h2>
|
||
<span id="variant.Nothing" class="variant small-section-header"><a href="#variant.Nothing" class="anchor field"></a><span id='Nothing.v' class='invisible'><code>Nothing</code></span></span><div class='docblock'><p>Decoded nothing.</p>
|
||
</div><span id="variant.GlobalPalette" class="variant small-section-header"><a href="#variant.GlobalPalette" class="anchor field"></a><span id='GlobalPalette.v' class='invisible'><code>GlobalPalette(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>>)</code></span></span><div class='docblock'><p>Global palette.</p>
|
||
</div><span id="variant.BackgroundColor" class="variant small-section-header"><a href="#variant.BackgroundColor" class="anchor field"></a><span id='BackgroundColor.v' class='invisible'><code>BackgroundColor(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>)</code></span></span><div class='docblock'><p>Index of the background color in the global palette.</p>
|
||
</div><span id="variant.Trailer" class="variant small-section-header"><a href="#variant.Trailer" class="anchor field"></a><span id='Trailer.v' class='invisible'><code>Trailer</code></span></span><div class='docblock'><p>Decoded the image trailer.</p>
|
||
</div><span id="variant.BlockStart" class="variant small-section-header"><a href="#variant.BlockStart" class="anchor field"></a><span id='BlockStart.v' class='invisible'><code>BlockStart(<a class="enum" href="../gif/enum.Block.html" title="enum gif::Block">Block</a>)</code></span></span><div class='docblock'><p>The start of a block.</p>
|
||
</div><span id="variant.SubBlockFinished" class="variant small-section-header"><a href="#variant.SubBlockFinished" class="anchor field"></a><span id='SubBlockFinished.v' class='invisible'><code>SubBlockFinished(<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><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>)</code></span></span><div class='docblock'><p>Decoded a sub-block. More sub-block are available.</p>
|
||
</div><span id="variant.BlockFinished" class="variant small-section-header"><a href="#variant.BlockFinished" class="anchor field"></a><span id='BlockFinished.v' class='invisible'><code>BlockFinished(<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><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>)</code></span></span><div class='docblock'><p>Decoded the last (or only) sub-block of a block.</p>
|
||
</div><span id="variant.Frame" class="variant small-section-header"><a href="#variant.Frame" class="anchor field"></a><span id='Frame.v' class='invisible'><code>Frame(&'a <a class="struct" href="../gif/struct.Frame.html" title="struct gif::Frame">Frame</a><'static>)</code></span></span><div class='docblock'><p>Decoded all information of the next frame.
|
||
The returned frame does <strong>not</strong> any image data.</p>
|
||
</div><span id="variant.Data" class="variant small-section-header"><a href="#variant.Data" class="anchor field"></a><span id='Data.v' class='invisible'><code>Data(<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>)</code></span></span><div class='docblock'><p>Decoded some data of the current frame.</p>
|
||
</div><span id="variant.DataEnd" class="variant small-section-header"><a href="#variant.DataEnd" class="anchor field"></a><span id='DataEnd.v' class='invisible'><code>DataEnd</code></span></span><div class='docblock'><p>No more data available the current frame.</p>
|
||
</div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl<'a> <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="enum" href="../gif/enum.Decoded.html" title="enum gif::Decoded">Decoded</a><'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#85' 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#85' 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> <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="enum" href="../gif/enum.Decoded.html" title="enum gif::Decoded">Decoded</a><'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> <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="enum" href="../gif/enum.Decoded.html" title="enum gif::Decoded">Decoded</a><'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> |