pnmixer-rust/png/enum.Decoded.html
2017-07-15 01:30:16 +02:00

130 lines
10 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!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 `png`.">
<meta name="keywords" content="rust, rustlang, rust-lang, Decoded">
<title>png::Decoded - 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 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">
<p class='location'>Enum Decoded</p><div class="block items"><ul><li><a href="#variants">Variants</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: 'Decoded', ty: 'enum', 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'>Enum <a href='index.html'>png</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'>&#x2212;</span>]
</a>
</span><a class='srclink' href='../src/png/decoder/stream.rs.html#43-56' title='goto source code'>[src]</a></span></h1>
<pre class='rust enum'>pub enum Decoded&lt;'a&gt; {
Nothing,
Header(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,&nbsp;<a class="enum" href="../png/enum.BitDepth.html" title="enum png::BitDepth">BitDepth</a>,&nbsp;<a class="enum" href="../png/enum.ColorType.html" title="enum png::ColorType">ColorType</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>),
ChunkBegin(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,&nbsp;<a class="type" href="../png/chunk/type.ChunkType.html" title="type png::chunk::ChunkType">ChunkType</a>),
ChunkComplete(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,&nbsp;<a class="type" href="../png/chunk/type.ChunkType.html" title="type png::chunk::ChunkType">ChunkType</a>),
PixelDimensions(<a class="struct" href="../png/struct.PixelDimensions.html" title="struct png::PixelDimensions">PixelDimensions</a>),
AnimationControl(<a class="struct" href="../png/struct.AnimationControl.html" title="struct png::AnimationControl">AnimationControl</a>),
FrameControl(&amp;'a <a class="struct" href="../png/struct.FrameControl.html" title="struct png::FrameControl">FrameControl</a>),
ImageData(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'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>),
PartialChunk(<a class="type" href="../png/chunk/type.ChunkType.html" title="type png::chunk::ChunkType">ChunkType</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'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>),
ImageEnd,
}</pre><div class='docblock'><p>Result of the decoding process</p>
</div><h2 id='variants' class='variants'>Variants</h2>
<span id='variant.Nothing' class='variant'><span id='Nothing.v' class='invisible'><code>Nothing</code></span></span><div class='docblock'><p>Nothing decoded yet</p>
</div><span id='variant.Header' class='variant'><span id='Header.v' class='invisible'><code>Header(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,&nbsp;<a class="enum" href="../png/enum.BitDepth.html" title="enum png::BitDepth">BitDepth</a>,&nbsp;<a class="enum" href="../png/enum.ColorType.html" title="enum png::ColorType">ColorType</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code></span></span><span id='variant.ChunkBegin' class='variant'><span id='ChunkBegin.v' class='invisible'><code>ChunkBegin(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,&nbsp;<a class="type" href="../png/chunk/type.ChunkType.html" title="type png::chunk::ChunkType">ChunkType</a>)</code></span></span><span id='variant.ChunkComplete' class='variant'><span id='ChunkComplete.v' class='invisible'><code>ChunkComplete(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,&nbsp;<a class="type" href="../png/chunk/type.ChunkType.html" title="type png::chunk::ChunkType">ChunkType</a>)</code></span></span><span id='variant.PixelDimensions' class='variant'><span id='PixelDimensions.v' class='invisible'><code>PixelDimensions(<a class="struct" href="../png/struct.PixelDimensions.html" title="struct png::PixelDimensions">PixelDimensions</a>)</code></span></span><span id='variant.AnimationControl' class='variant'><span id='AnimationControl.v' class='invisible'><code>AnimationControl(<a class="struct" href="../png/struct.AnimationControl.html" title="struct png::AnimationControl">AnimationControl</a>)</code></span></span><span id='variant.FrameControl' class='variant'><span id='FrameControl.v' class='invisible'><code>FrameControl(&amp;'a <a class="struct" href="../png/struct.FrameControl.html" title="struct png::FrameControl">FrameControl</a>)</code></span></span><span id='variant.ImageData' class='variant'><span id='ImageData.v' class='invisible'><code>ImageData(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'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 raw image data.</p>
</div><span id='variant.PartialChunk' class='variant'><span id='PartialChunk.v' class='invisible'><code>PartialChunk(<a class="type" href="../png/chunk/type.ChunkType.html" title="type png::chunk::ChunkType">ChunkType</a>,&nbsp;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'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><span id='variant.ImageEnd' class='variant'><span id='ImageEnd.v' class='invisible'><code>ImageEnd</code></span></span><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl&lt;'a&gt; <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="../png/enum.Decoded.html" title="enum png::Decoded">Decoded</a>&lt;'a&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/png/decoder/stream.rs.html#41' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span></h4>
<div class='docblock'><p>Formats the value using the given formatter.</p>
</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>?</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>