mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-05 03:28:41 +00:00
19 lines
19 KiB
HTML
19 lines
19 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 `PNMHeader` struct in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, PNMHeader"><title>image::pnm::PNMHeader - 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 PNMHeader</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.subtype">subtype</a><a href="#method.width">width</a><a href="#method.height">height</a><a href="#method.maximal_sample">maximal_sample</a><a href="#method.as_bitmap">as_bitmap</a><a href="#method.as_graymap">as_graymap</a><a href="#method.as_pixmap">as_pixmap</a><a href="#method.as_arbitrary">as_arbitrary</a><a href="#method.write">write</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-From%3CBitmapHeader%3E">From<BitmapHeader></a><a href="#impl-From%3CGraymapHeader%3E">From<GraymapHeader></a><a href="#impl-From%3CPixmapHeader%3E">From<PixmapHeader></a><a href="#impl-From%3CArbitraryHeader%3E">From<ArbitraryHeader></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'>image</a>::<wbr><a href='index.html'>pnm</a></p><script>window.sidebarCurrent = {name: 'PNMHeader', 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'>image</a>::<wbr><a href='index.html'>pnm</a>::<wbr><a class="struct" href=''>PNMHeader</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/image/pnm/header.rs.html#35-38' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct PNMHeader { /* fields omitted */ }</pre></div><div class='docblock'><p>Stores the complete header data of a file.</p>
|
||
<p>Internally, provides mechanisms for lossless reencoding. After reading a file with the decoder
|
||
it is possible to recover the header and construct an encoder. Using the encoder on the just
|
||
loaded image should result in a byte copy of the original file (for single image pnms without
|
||
additional trailing data).</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 <a class="struct" href="../../image/pnm/struct.PNMHeader.html" title="struct image::pnm::PNMHeader">PNMHeader</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#161-312' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.subtype' class="method"><span id='subtype.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.subtype' class='fnname'>subtype</a>(&self) -> <a class="enum" href="../../image/pnm/enum.PNMSubtype.html" title="enum image::pnm::PNMSubtype">PNMSubtype</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#163-170' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Retrieve the format subtype from which the header was created.</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.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#173-180' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The width of the image this header is for.</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.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#183-190' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The height of the image this header is for.</p>
|
||
</div><h4 id='method.maximal_sample' class="method"><span id='maximal_sample.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.maximal_sample' class='fnname'>maximal_sample</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#193-200' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>The biggest value a sample can have. In other words, the colour resolution.</p>
|
||
</div><h4 id='method.as_bitmap' class="method"><span id='as_bitmap.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.as_bitmap' class='fnname'>as_bitmap</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="struct" href="../../image/pnm/struct.BitmapHeader.html" title="struct image::pnm::BitmapHeader">BitmapHeader</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#203-208' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Retrieve the underlying bitmap header if any</p>
|
||
</div><h4 id='method.as_graymap' class="method"><span id='as_graymap.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.as_graymap' class='fnname'>as_graymap</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="struct" href="../../image/pnm/struct.GraymapHeader.html" title="struct image::pnm::GraymapHeader">GraymapHeader</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#211-216' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Retrieve the underlying graymap header if any</p>
|
||
</div><h4 id='method.as_pixmap' class="method"><span id='as_pixmap.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.as_pixmap' class='fnname'>as_pixmap</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="struct" href="../../image/pnm/struct.PixmapHeader.html" title="struct image::pnm::PixmapHeader">PixmapHeader</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#219-224' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Retrieve the underlying pixmap header if any</p>
|
||
</div><h4 id='method.as_arbitrary' class="method"><span id='as_arbitrary.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.as_arbitrary' class='fnname'>as_arbitrary</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="struct" href="../../image/pnm/struct.ArbitraryHeader.html" title="struct image::pnm::ArbitraryHeader">ArbitraryHeader</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#227-232' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Retrieve the underlying arbitrary header if any</p>
|
||
</div><h4 id='method.write' class="method"><span id='write.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.write' class='fnname'>write</a>(&self, writer: &mut <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/std/io/error/type.Result.html" title="type std::io::error::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#235-311' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Write the header back into a binary stream</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-From%3CBitmapHeader%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../image/pnm/struct.BitmapHeader.html" title="struct image::pnm::BitmapHeader">BitmapHeader</a>> for <a class="struct" href="../../image/pnm/struct.PNMHeader.html" title="struct image::pnm::PNMHeader">PNMHeader</a></code><a href='#impl-From%3CBitmapHeader%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#314-321' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from' class="method"><span id='from.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(header: <a class="struct" href="../../image/pnm/struct.BitmapHeader.html" title="struct image::pnm::BitmapHeader">BitmapHeader</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#315-320' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-From%3CGraymapHeader%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../image/pnm/struct.GraymapHeader.html" title="struct image::pnm::GraymapHeader">GraymapHeader</a>> for <a class="struct" href="../../image/pnm/struct.PNMHeader.html" title="struct image::pnm::PNMHeader">PNMHeader</a></code><a href='#impl-From%3CGraymapHeader%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#323-330' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-1' class="method"><span id='from.v-1' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(header: <a class="struct" href="../../image/pnm/struct.GraymapHeader.html" title="struct image::pnm::GraymapHeader">GraymapHeader</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#324-329' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-From%3CPixmapHeader%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../image/pnm/struct.PixmapHeader.html" title="struct image::pnm::PixmapHeader">PixmapHeader</a>> for <a class="struct" href="../../image/pnm/struct.PNMHeader.html" title="struct image::pnm::PNMHeader">PNMHeader</a></code><a href='#impl-From%3CPixmapHeader%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#332-339' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-2' class="method"><span id='from.v-2' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(header: <a class="struct" href="../../image/pnm/struct.PixmapHeader.html" title="struct image::pnm::PixmapHeader">PixmapHeader</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#333-338' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</p>
|
||
</div></div><h3 id='impl-From%3CArbitraryHeader%3E' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><<a class="struct" href="../../image/pnm/struct.ArbitraryHeader.html" title="struct image::pnm::ArbitraryHeader">ArbitraryHeader</a>> for <a class="struct" href="../../image/pnm/struct.PNMHeader.html" title="struct image::pnm::PNMHeader">PNMHeader</a></code><a href='#impl-From%3CArbitraryHeader%3E' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#341-348' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.from-3' class="method"><span id='from.v-3' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(header: <a class="struct" href="../../image/pnm/struct.ArbitraryHeader.html" title="struct image::pnm::ArbitraryHeader">ArbitraryHeader</a>) -> Self</code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/image/pnm/header.rs.html#342-347' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Performs the conversion.</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 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="../../image/pnm/struct.PNMHeader.html" title="struct image::pnm::PNMHeader">PNMHeader</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 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="../../image/pnm/struct.PNMHeader.html" title="struct image::pnm::PNMHeader">PNMHeader</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 = "image";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html> |