|
|
|
|
|
<!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 `ImageDecoder` trait in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, ImageDecoder"><title>image::ImageDecoder - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc trait"><!--[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><a href='../image/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Trait ImageDecoder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Reader">Reader</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.colortype">colortype</a><a href="#tymethod.dimensions">dimensions</a><a href="#tymethod.into_reader">into_reader</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.read_image">read_image</a><a href="#method.read_image_with_progress">read_image_with_progress</a><a href="#method.row_bytes">row_bytes</a><a href="#method.scanline_bytes">scanline_bytes</a><a href="#method.total_bytes">total_bytes</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='index.html'>image</a></p><script>window.sidebarCurrent = {name: 'ImageDecoder', ty: 'trait', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/image.rs.html#362-435' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='index.html'>image</a>::<wbr><a class="trait" href=''>ImageDecoder</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait ImageDecoder: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
|
|
|
|
type <a href='#associatedtype.Reader' class="type">Reader</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>;
|
|
|
|
|
|
fn <a href='#tymethod.dimensions' class='fnname'>dimensions</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.colortype' class='fnname'>colortype</a>(&self) -> <a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">ColorType</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.into_reader' class='fnname'>into_reader</a>(self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><Self::<a class="type" href="../image/trait.ImageDecoder.html#associatedtype.Reader" title="type image::ImageDecoder::Reader">Reader</a>>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.row_bytes' class='fnname'>row_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.total_bytes' class='fnname'>total_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.scanline_bytes' class='fnname'>scanline_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.read_image' class='fnname'>read_image</a>(self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<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>>> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.read_image_with_progress' class='fnname'>read_image_with_progress</a><F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Progress)>(<br> self, <br> progress_callback: F<br> ) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<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>>> { ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>The trait that all decoders implement</p>
|
|
|
|
|
|
</div>
|
|
|
|
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Reader' class='method'><code id='Reader.t'>type <a href='#associatedtype.Reader' class="type">Reader</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a></code></h3><div class='docblock'><p>The type of reader produced by <code>into_reader</code>.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.dimensions' class='method'><code id='dimensions.v'>fn <a href='#tymethod.dimensions' class='fnname'>dimensions</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><div class='docblock'><p>Returns a tuple containing the width and height of the image</p>
|
|
|
|
|
|
</div><h3 id='tymethod.colortype' class='method'><code id='colortype.v'>fn <a href='#tymethod.colortype' class='fnname'>colortype</a>(&self) -> <a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">ColorType</a></code></h3><div class='docblock'><p>Returns the color type of the image e.g. RGB(8) (8bit RGB)</p>
|
|
|
|
|
|
</div><h3 id='tymethod.into_reader' class='method'><code id='into_reader.v'>fn <a href='#tymethod.into_reader' class='fnname'>into_reader</a>(self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><Self::<a class="type" href="../image/trait.ImageDecoder.html#associatedtype.Reader" title="type image::ImageDecoder::Reader">Reader</a>></code></h3><div class='docblock'><p>Returns a reader that can be used to obtain the bytes of the image. For the best
|
|
|
|
|
|
performance, always try to read at least <code>scanline_bytes</code> from the reader at a time. Reading
|
|
|
|
|
|
fewer bytes will cause the reader to perform internal buffering.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.row_bytes' class='method'><code id='row_bytes.v'>fn <a href='#method.row_bytes' class='fnname'>row_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></h3><div class='docblock'><p>Returns the number of bytes in a single row of the image. All decoders will pad image rows
|
|
|
|
|
|
to a byte boundary.</p>
|
|
|
|
|
|
</div><h3 id='method.total_bytes' class='method'><code id='total_bytes.v'>fn <a href='#method.total_bytes' class='fnname'>total_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></h3><div class='docblock'><p>Returns the total number of bytes in the image.</p>
|
|
|
|
|
|
</div><h3 id='method.scanline_bytes' class='method'><code id='scanline_bytes.v'>fn <a href='#method.scanline_bytes' class='fnname'>scanline_bytes</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></h3><div class='docblock'><p>Returns the minimum number of bytes that can be efficiently read from this decoder. This may
|
|
|
|
|
|
be as few as 1 or as many as <code>total_bytes()</code>.</p>
|
|
|
|
|
|
</div><h3 id='method.read_image' class='method'><code id='read_image.v'>fn <a href='#method.read_image' class='fnname'>read_image</a>(self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<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></h3><div class='docblock'><p>Returns all the bytes in the image.</p>
|
|
|
|
|
|
</div><h3 id='method.read_image_with_progress' class='method'><code id='read_image_with_progress.v'>fn <a href='#method.read_image_with_progress' class='fnname'>read_image_with_progress</a><F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(Progress)>(<br> self, <br> progress_callback: F<br>) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<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></h3><div class='docblock'><p>Same as <code>read_image</code> but periodically calls the provided callback to give updates on loading
|
|
|
|
|
|
progress.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-ImageDecoder' class='impl'><code class='in-band'>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.BufRead.html" title="trait std::io::BufRead">BufRead</a>> ImageDecoder for <a class="struct" href="../image/hdr/struct.HDRAdapter.html" title="struct image::hdr::HDRAdapter">HDRAdapter</a><R></code><a href='#impl-ImageDecoder' class='anchor'></a><a class='srclink' href='../src/image/hdr/decoder.rs.html#69-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Reader-1' class="type"><code id='Reader.t-1'>type <a href='#associatedtype.Reader-1' class="type">Reader</a> = <a class="struct" href="https://doc.rust-lang.org/nightly/std/io/cursor/struct.Cursor.html" title="struct std::io::cursor::Cursor">Cursor</a><<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></h4><h4 id='method.dimensions' class="method hidden"><code id='dimensions.v-1'>fn <a href='#method.dimensions' class='fnname'>dimensions</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../src/image/hdr/decoder.rs.html#72-74' title='goto source code'>[src]</a></h4><h4 id='method.colortype' class="method hidden"><code id='colortype.v-1'>fn <a href='#method.colortype' class='fnname'>colortype</a>(&self) -> <a class="enum" href="../image/enum.ColorType.html" title="enum image::ColorType">ColorType</a></code><a class='srclink' href='../src/image/hdr/decoder.rs.html#76-78' title='goto source code'>[src]</a></h4><h4 id='method.into_reader' class="method hidden"><code id='into_reader.v-1'>fn <a href='#method.into_reader' class='fnname'>into_reader</a>(self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><Self::<a class="type" href="../image/trait.ImageDecoder.html#associatedtype.Reader" title="type image::ImageDecoder::Reader">Reader</a>></code><a class='srclink' href='../src/image/hdr/decoder.rs.html#80-82' title='goto source code'>[src]</a></h4><h4 id='method.read_image-1' class="method hidden"><code id='read_image.v-1'>fn <a href='#method.read_image-1' class='fnname'>read_image</a>(self) -> <a class="type" href="../image/type.ImageResult.html" title="type image::ImageResult">ImageResult</a><<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><a class='srclink' href='../src/image/hdr/decoder.rs.html#84-91' title='goto source code'>[src]</a></h4></div><h3 id='impl-ImageDecoder-1' class='impl'><code class='in-band'>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Seek.html" title="trait std::io::Seek">Seek</a>> ImageDecoder for <a class="struct" href="../image/bmp/struct.BMPDecoder.html" title="struct image::bmp::BMPDecoder">BMPDecoder</a><R></code><a href='#impl-ImageDecoder-1' class='anchor'></a><a class='srclink' href='../src/image/bmp/decoder.rs.html#1258-1280' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Reader-2' class="type"><code id='Reader.t-2'>type <a href='#associatedtype.Reader-2' class="type">Reader</a
|
|
|
|
|
|
src="../implementors/image/trait.ImageDecoder.js">
|
|
|
|
|
|
</script></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>
|
