pnmixer-rust/png/struct.Decoder.html

119 lines
6.8 KiB
HTML
Raw Normal View History

2017-07-14 23:30:16 +00:00
<!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 `png`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Decoder">
<title>png::Decoder - Rust</title>
<link rel="stylesheet" type="text/css" href="../normalize.css">
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</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">
<p class='location'>Struct Decoder</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='index.html'>png</a></p><script>window.sidebarCurrent = {name: 'Decoder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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">
</div>
</form>
</nav>
<section id='main' class="content">
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>png</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/png/decoder/mod.rs.html#56-61' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct Decoder&lt;R:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>&gt; { /* fields omitted */ }</pre><div class='docblock'><p>PNG Decoder</p>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl&lt;R:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>&gt; <a class="struct" href="../png/struct.Decoder.html" title="struct png::Decoder">Decoder</a>&lt;R&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/png/decoder/mod.rs.html#63-89' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>(r: R) -&gt; <a class="struct" href="../png/struct.Decoder.html" title="struct png::Decoder">Decoder</a>&lt;R&gt;</code></span></h4>
<h4 id='method.read_info' class="method"><span id='read_info.v' class='invisible'><code>fn <a href='#method.read_info' class='fnname'>read_info</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../png/struct.OutputInfo.html" title="struct png::OutputInfo">OutputInfo</a>, <a class="struct" href="../png/struct.Reader.html" title="struct png::Reader">Reader</a>&lt;R&gt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>, <a class="enum" href="../png/enum.DecodingError.html" title="enum png::DecodingError">DecodingError</a>&gt;</code></span></h4>
<div class='docblock'><p>Reads all meta data until the first IDAT chunk</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl&lt;R:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>&gt; <a class="trait" href="../png/trait.HasParameters.html" title="trait png::HasParameters">HasParameters</a> for <a class="struct" href="../png/struct.Decoder.html" title="struct png::Decoder">Decoder</a>&lt;R&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/png/decoder/mod.rs.html#91' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.set' class="method"><span id='set.v' class='invisible'><code>fn <a href='../png/trait.HasParameters.html#method.set' class='fnname'>set</a>&lt;T:&nbsp;<a class="trait" href="../png/trait.Parameter.html" title="trait png::Parameter">Parameter</a>&lt;Self&gt;&gt;(&amp;mut self, value: T) -&gt; &amp;mut Self</code></span></h4>
</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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
<dt>+</dt>
<dd>Collapse/expand 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>
</div>
</div>
</aside>
<script>
window.rootPath = "../";
window.currentCrate = "png";
</script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>