mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
21 lines
17 KiB
HTML
21 lines
17 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 `Reader` struct in crate `gif`."><meta name="keywords" content="rust, rustlang, rust-lang, Reader"><title>gif::Reader - 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 Reader</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.next_frame_info">next_frame_info</a><a href="#method.read_next_frame">read_next_frame</a><a href="#method.read_into_buffer">read_into_buffer</a><a href="#method.fill_buffer">fill_buffer</a><a href="#method.buffer_size">buffer_size</a><a href="#method.line_length">line_length</a><a href="#method.palette">palette</a><a href="#method.global_palette">global_palette</a><a href="#method.width">width</a><a href="#method.height">height</a><a href="#method.bg_color">bg_color</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: 'Reader', 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=''>Reader</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#125-136' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Reader<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="struct" href="../gif/struct.Reader.html" title="struct gif::Reader">Reader</a><R> <span class="where fmt-newline">where<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' 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#138-374' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.next_frame_info' class="method"><span id='next_frame_info.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.next_frame_info' class='fnname'>next_frame_info</a>(<br> &mut self<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="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../gif/struct.Frame.html" title="struct gif::Frame">Frame</a><'static>>, <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#192-218' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the next frame info</p>
|
||
</div><h4 id='method.read_next_frame' class="method"><span id='read_next_frame.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_next_frame' class='fnname'>read_next_frame</a>(<br> &mut self<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="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&<a class="struct" href="../gif/struct.Frame.html" title="struct gif::Frame">Frame</a><'static>>, <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#224-234' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Reads the next frame from the image.</p>
|
||
<p>Do not call <code>Self::next_frame_info</code> beforehand.
|
||
Deinterlaces the result.</p>
|
||
</div><h4 id='method.read_into_buffer' class="method"><span id='read_into_buffer.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.read_into_buffer' class='fnname'>read_into_buffer</a>(&mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</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="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.unit.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/mod.rs.html#241-257' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Reads the data of the current frame into a pre-allocated buffer.</p>
|
||
<p><code>Self::next_frame_info</code> needs to be called beforehand.
|
||
The length of <code>buf</code> must be at least <code>Self::buffer_size</code>.
|
||
Deinterlaces the result.</p>
|
||
</div><h4 id='method.fill_buffer' class="method"><span id='fill_buffer.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.fill_buffer' class='fnname'>fill_buffer</a>(&mut self, buf: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</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="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.bool.html">bool</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/mod.rs.html#264-328' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Reads data of the current frame into a pre-allocated buffer until the buffer has been
|
||
filled completely.</p>
|
||
<p><code>Self::next_frame_info</code> needs to be called beforehand. Returns <code>true</code> if the supplied
|
||
buffer could be filled completely. Should not be called after <code>false</code> had been returned.</p>
|
||
</div><h4 id='method.buffer_size' class="method"><span id='buffer_size.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.buffer_size' class='fnname'>buffer_size</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#331-333' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Output buffer size</p>
|
||
</div><h4 id='method.line_length' class="method"><span id='line_length.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.line_length' class='fnname'>line_length</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#336-342' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Line length of the current frame</p>
|
||
</div><h4 id='method.palette' class="method"><span id='palette.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.palette' class='fnname'>palette</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="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="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#345-353' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the color palette relevant for the current (next) frame</p>
|
||
</div><h4 id='method.global_palette' class="method"><span id='global_palette.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.global_palette' class='fnname'>global_palette</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</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>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#356-358' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The global color palette</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/mod.rs.html#361-363' 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/mod.rs.html#366-368' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Height of the image</p>
|
||
</div><h4 id='method.bg_color' class="method"><span id='bg_color.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.bg_color' class='fnname'>bg_color</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/gif/reader/mod.rs.html#371-373' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Index of the background color in the global palette</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<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.Reader.html" title="struct gif::Reader">Reader</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.Reader.html" title="struct gif::Reader">Reader</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> |