You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
206 lines
71 KiB
206 lines
71 KiB
5 years ago
|
<!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 `FlatSamples` struct in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, FlatSamples"><title>image::flat::FlatSamples - 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 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><a href='../../image/index.html'><div class='logo-container'><img src='../../rust-logo.png' alt='logo'></div></a><p class='location'>Struct FlatSamples</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.samples">samples</a><a href="#structfield.layout">layout</a><a href="#structfield.color_hint">color_hint</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.as_mut">as_mut</a><a href="#method.as_mut_slice">as_mut_slice</a><a href="#method.as_ref">as_ref</a><a href="#method.as_slice">as_slice</a><a href="#method.as_view">as_view</a><a href="#method.as_view_mut">as_view_mut</a><a href="#method.as_view_with_mut_samples">as_view_with_mut_samples</a><a href="#method.bounds">bounds</a><a href="#method.extents">extents</a><a href="#method.fits">fits</a><a href="#method.get_mut_sample">get_mut_sample</a><a href="#method.get_sample">get_sample</a><a href="#method.has_aliased_samples">has_aliased_samples</a><a href="#method.image_mut_slice">image_mut_slice</a><a href="#method.image_slice">image_slice</a><a href="#method.in_bounds">in_bounds</a><a href="#method.in_bounds_index">in_bounds_index</a><a href="#method.index">index</a><a href="#method.index_ignoring_bounds">index_ignoring_bounds</a><a href="#method.is_normal">is_normal</a><a href="#method.min_length">min_length</a><a href="#method.shrink_to">shrink_to</a><a href="#method.strides_cwh">strides_cwh</a><a href="#method.to_vec">to_vec</a><a href="#method.try_into_buffer">try_into_buffer</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Index%3C(u8%2C%20u32%2C%20u32)%3E">Index<(u8, u32, u32)></a><a href="#impl-IndexMut%3C(u8%2C%20u32%2C%20u32)%3E">IndexMut<(u8, u32, u32)></a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-SetParameter">SetParameter</a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='../index.html'>image</a>::<wbr><a href='index.html'>flat</a></p><script>window.sidebarCurrent = {name: 'FlatSamples', ty: 's
|
||
|
|
pub samples: Buffer,
|
||
|
|
pub layout: <a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a>,
|
||
|
|
pub color_hint: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../image/enum.ColorType.html" title="enum image::ColorType">ColorType</a>>,
|
||
|
|
}</pre></div><div class='docblock'><p>A flat buffer over a (multi channel) image.</p>
|
||
|
|
<p>In contrast to <code>ImageBuffer</code>, this representation of a sample collection is much more lenient
|
||
|
|
in the layout thereof. In particular, it also allows grouping by color planes instead of by
|
||
|
|
pixel, at least for the purpose of a <code>GenericImageView</code>.</p>
|
||
|
|
<p>Note that the strides need not conform to the assumption that constructed indices actually
|
||
|
|
refer inside the underlying buffer but return values of library functions will always guarantee
|
||
|
|
this. To manually make this check use <code>check_index_validities</code> and maybe put that inside an
|
||
|
|
assert.</p>
|
||
|
|
</div><h2 id='fields' class='fields small-section-header'>
|
||
|
|
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.samples" class="structfield small-section-header"><a href="#structfield.samples" class="anchor field"></a><code id="samples.v">samples: Buffer</code></span><div class='docblock'><p>Underlying linear container holding sample values.</p>
|
||
|
|
</div><span id="structfield.layout" class="structfield small-section-header"><a href="#structfield.layout" class="anchor field"></a><code id="layout.v">layout: <a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></code></span><div class='docblock'><p>A <code>repr(C)</code> description of the layout of buffer samples.</p>
|
||
|
|
</div><span id="structfield.color_hint" class="structfield small-section-header"><a href="#structfield.color_hint" class="anchor field"></a><code id="color_hint.v">color_hint: <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="../../image/enum.ColorType.html" title="enum image::ColorType">ColorType</a>></code></span><div class='docblock'><p>Supplementary color information.</p>
|
||
|
|
<p>You may keep this as <code>None</code> in most cases. This is NOT checked in <code>View</code> or other
|
||
|
|
converters. It is intended mainly as a way for types that convert to this buffer type to
|
||
|
|
attach their otherwise static color information. A dynamic image representation could
|
||
|
|
however use this to resolve representational ambiguities such as the order of RGB channels.</p>
|
||
|
|
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl<Buffer> <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#436-855' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.strides_cwh' class="method"><code id='strides_cwh.v'>pub fn <a href='#method.strides_cwh' class='fnname'>strides_cwh</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.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../../src/image/flat.rs.html#441-443' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the strides for indexing matrix-like <code>[(c, w, h)]</code>.</p>
|
||
|
|
<p>For a row-major layout with grouped samples, this tuple is strictly
|
||
|
|
increasing.</p>
|
||
|
|
</div><h4 id='method.extents' class="method"><code id='extents.v'>pub fn <a href='#method.extents' class='fnname'>extents</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.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../../src/image/flat.rs.html#449-451' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the dimensions <code>(channels, width, height)</code>.</p>
|
||
|
|
<p>The interface is optimized for use with <code>strides_cwh</code> instead. The channel extent will be
|
||
|
|
before width and height.</p>
|
||
|
|
</div><h4 id='method.bounds' class="method"><code id='bounds.v'>pub fn <a href='#method.bounds' class='fnname'>bounds</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.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../../src/image/flat.rs.html#457-459' title='goto source code'>[src]</a></h4><div class='docblock'><p>Tuple of bounds in the order of coordinate inputs.</p>
|
||
|
|
<p>This function should be used whenever working with image coordinates opposed to buffer
|
||
|
|
coordinates. The only difference compared to <code>extents</code> is the output type.</p>
|
||
|
|
</div><h4 id='method.as_ref' class="method"><code id='as_ref.v'>pub fn <a href='#method.as_ref' class='fnname'>as_ref</a><T>(&self) -> <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[T]</a>> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#462-468' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get a reference based version.</p>
|
||
|
|
</div><h4 id='method.as_mut' class="method"><code id='as_mut.v'>pub fn <a href='#method.as_mut' class='fnname'>as_mut</a><T>(&mut self) -> <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a>> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#471-477' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get a mutable reference based version.</p>
|
||
|
|
</div><h4 id='method.to_vec' class="method"><code id='to_vec.v'>pub fn <a href='#method.to_vec' class='fnname'>to_vec</a><T>(&self) -> <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/vec/struct.Vec.html" title="struct alloc::vec::Vec">Vec</a><T>> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#480-488' title='goto source code'>[src]</a></h4><div class='docblock'><p>Copy the data into an owned vector.</p>
|
||
|
|
</div><h4 id='method.get_sample' class="method"><code id='get_sample.v'>pub fn <a href='#method.get_sample' class='fnname'>get_sample</a><T>(&self, channel: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#511-515' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get a reference to a single sample.</p>
|
||
|
|
<p>This more restrictive than the method based on <code>std::ops::Index</code> but guarantees to properly
|
||
|
|
check all bounds and not panic as long as <code>Buffer::as_ref</code> does not do so.</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">let</span> <span class="ident">flat</span> <span class="op">=</span> <span class="ident">RgbImage</span>::<span class="ident">new</span>(<span class="number">480</span>, <span class="number">640</span>).<span class="ident">into_flat_samples</span>();
|
||
|
|
|
||
|
|
<span class="comment">// Get the blue channel at (10, 10).</span>
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">flat</span>.<span class="ident">get_sample</span>(<span class="number">1</span>, <span class="number">10</span>, <span class="number">10</span>).<span class="ident">is_some</span>());
|
||
|
|
|
||
|
|
<span class="comment">// There is no alpha channel.</span>
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">flat</span>.<span class="ident">get_sample</span>(<span class="number">3</span>, <span class="number">10</span>, <span class="number">10</span>).<span class="ident">is_none</span>());</pre></div>
|
||
|
|
<p>For cases where a special buffer does not provide <code>AsRef<[T]></code>, consider encapsulating
|
||
|
|
bounds checks with <code>min_length</code> in a type similar to <code>View</code>. Then you may use
|
||
|
|
<code>in_bounds_index</code> as a small speedup over the index calculation of this method which relies
|
||
|
|
on <code>index_ignoring_bounds</code> since it can not have a-priori knowledge that the sample
|
||
|
|
coordinate is in fact backed by any memory buffer.</p>
|
||
|
|
</div><h4 id='method.get_mut_sample' class="method"><code id='get_mut_sample.v'>pub fn <a href='#method.get_mut_sample' class='fnname'>get_mut_sample</a><T>(<br> &mut self, <br> channel: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, <br> x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <br> y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><br>) -> <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.reference.html">&mut </a>T> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#544-551' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get a mutable reference to a single sample.</p>
|
||
|
|
<p>This more restrictive than the method based on <code>std::ops::IndexMut</code> but guarantees to
|
||
|
|
properly check all bounds and not panic as long as <code>Buffer::as_ref</code> does not do so.
|
||
|
|
Contrary to conversion to <code>ViewMut</code>, this does not require that samples are packed since it
|
||
|
|
does not need to convert samples to a color representation.</p>
|
||
|
|
<p><strong>WARNING</strong>: Note that of course samples may alias, so that the mutable reference returned
|
||
|
|
here can in fact modify more than the coordinate in the argument.</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">flat</span> <span class="op">=</span> <span class="ident">RgbImage</span>::<span class="ident">new</span>(<span class="number">480</span>, <span class="number">640</span>).<span class="ident">into_flat_samples</span>();
|
||
|
|
|
||
|
|
<span class="comment">// Assign some new color to the blue channel at (10, 10).</span>
|
||
|
|
<span class="kw-2">*</span><span class="ident">flat</span>.<span class="ident">get_mut_sample</span>(<span class="number">1</span>, <span class="number">10</span>, <span class="number">10</span>).<span class="ident">unwrap</span>() <span class="op">=</span> <span class="number">255</span>;
|
||
|
|
|
||
|
|
<span class="comment">// There is no alpha channel.</span>
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">flat</span>.<span class="ident">get_mut_sample</span>(<span class="number">3</span>, <span class="number">10</span>, <span class="number">10</span>).<span class="ident">is_none</span>());</pre></div>
|
||
|
|
<p>For cases where a special buffer does not provide <code>AsRef<[T]></code>, consider encapsulating
|
||
|
|
bounds checks with <code>min_length</code> in a type similar to <code>View</code>. Then you may use
|
||
|
|
<code>in_bounds_index</code> as a small speedup over the index calculation of this method which relies
|
||
|
|
on <code>index_ignoring_bounds</code> since it can not have a-priori knowledge that the sample
|
||
|
|
coordinate is in fact backed by any memory buffer.</p>
|
||
|
|
</div><h4 id='method.as_view' class="method"><code id='as_view.v'>pub fn <a href='#method.as_view' class='fnname'>as_view</a><P>(&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="struct" href="../../image/flat/struct.View.html" title="struct image::flat::View">View</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[</a>P::<a class="type" href="../../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, P>, <a class="enum" href="../../image/flat/enum.Error.html" title="enum image::flat::Error">Error</a>> <span class="where fmt-newline">where<br> P: <a class="trait" href="../../image/trait.Pixel.html" title="trait image::Pixel">Pixel</a>,<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>P::<a class="type" href="../../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#559-579' title='goto source code'>[src]</a></h4><div class='docblock'><p>View this buffer as an image over some type of pixel.</p>
|
||
|
|
<p>This first ensures that all in-bounds coordinates refer to valid indices in the sample
|
||
|
|
buffer. It also checks that the specified pixel format expects the same number of channels
|
||
|
|
that are present in this buffer. Neither are larger nor a smaller number will be accepted.
|
||
|
|
There is no automatic conversion.</p>
|
||
|
|
</div><h4 id='method.as_view_with_mut_samples' class="method"><code id='as_view_with_mut_samples.v'>pub fn <a href='#method.as_view_with_mut_samples' class='fnname'>as_view_with_mut_samples</a><P>(<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="struct" href="../../image/flat/struct.View.html" title="struct image::flat::View">View</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a>P::<a class="type" href="../../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, P>, <a class="enum" href="../../image/flat/enum.Error.html" title="enum image::flat::Error">Error</a>> <span class="where fmt-newline">where<br> P: <a class="trait" href="../../image/trait.Pixel.html" title="trait image::Pixel">Pixel</a>,<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>P::<a class="type" href="../../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#596-616' title='goto source code'>[src]</a></h4><div class='docblock'><p>View this buffer but keep mutability at a sample level.</p>
|
||
|
|
<p>This is similar to <code>as_view</code> but subtly different from <code>as_view_mut</code>. The resulting type
|
||
|
|
can be used as a <code>GenericImage</code> with the same prior invariants needed as for <code>as_view</code>.
|
||
|
|
It can not be used as a mutable <code>GenericImage</code> but does not need channels to be packed in
|
||
|
|
their pixel representation.</p>
|
||
|
|
<p>This first ensures that all in-bounds coordinates refer to valid indices in the sample
|
||
|
|
buffer. It also checks that the specified pixel format expects the same number of channels
|
||
|
|
that are present in this buffer. Neither are larger nor a smaller number will be accepted.
|
||
|
|
There is no automatic conversion.</p>
|
||
|
|
<p><strong>WARNING</strong>: Note that of course samples may alias, so that the mutable reference returned
|
||
|
|
for one sample can in fact modify other samples as well. Sometimes exactly this is
|
||
|
|
intended.</p>
|
||
|
|
</div><h4 id='method.as_view_mut' class="method"><code id='as_view_mut.v'>pub fn <a href='#method.as_view_mut' class='fnname'>as_view_mut</a><P>(<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="struct" href="../../image/flat/struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a>P::<a class="type" href="../../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>, P>, <a class="enum" href="../../image/flat/enum.Error.html" title="enum image::flat::Error">Error</a>> <span class="where fmt-newline">where<br> P: <a class="trait" href="../../image/trait.Pixel.html" title="trait image::Pixel">Pixel</a>,<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>P::<a class="type" href="../../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#629-653' title='goto source code'>[src]</a></h4><div class='docblock'><p>Interpret this buffer as a mutable image.</p>
|
||
|
|
<p>To succeed, the pixels in this buffer may not alias each other and the samples of each
|
||
|
|
pixel must be packed (i.e. <code>channel_stride</code> is <code>1</code>). The number of channels must be
|
||
|
|
consistent with the channel count expected by the pixel format.</p>
|
||
|
|
<p>This is similar to an <code>ImageBuffer</code> except it is a temporary view that is not normalized as
|
||
|
|
strongly. To get an owning version, consider copying the data into an <code>ImageBuffer</code>. This
|
||
|
|
provides many more operations, is possibly faster (if not you may want to open an issue) is
|
||
|
|
generally polished. You can also try to convert this buffer inline, see
|
||
|
|
<code>ImageBuffer::from_raw</code>.</p>
|
||
|
|
</div><h4 id='method.as_slice' class="method"><code id='as_slice.v'>pub fn <a href='#method.as_slice' class='fnname'>as_slice</a><T>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[T]</a> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#659-661' title='goto source code'>[src]</a></h4><div class='docblock'><p>View the samples as a slice.</p>
|
||
|
|
<p>The slice is not limited to the region of the image and not all sample indices are valid
|
||
|
|
indices into this buffer. See <code>image_mut_slice</code> as an alternative.</p>
|
||
|
|
</div><h4 id='method.as_mut_slice' class="method"><code id='as_mut_slice.v'>pub fn <a href='#method.as_mut_slice' class='fnname'>as_mut_slice</a><T>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [T]</a> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#667-669' title='goto source code'>[src]</a></h4><div class='docblock'><p>View the samples as a slice.</p>
|
||
|
|
<p>The slice is not limited to the region of the image and not all sample indices are valid
|
||
|
|
indices into this buffer. See <code>image_mut_slice</code> as an alternative.</p>
|
||
|
|
</div><h4 id='method.image_slice' class="method"><code id='image_slice.v'>pub fn <a href='#method.image_slice' class='fnname'>image_slice</a><T>(&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">&[T]</a>> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsRef.html" title="trait core::convert::AsRef">AsRef</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#676-688' title='goto source code'>[src]</a></h4><div class='docblock'><p>Return the portion of the buffer that holds sample values.</p>
|
||
|
|
<p>This may fail when the coordinates in this image are either out-of-bounds of the underlying
|
||
|
|
buffer or can not be represented. Note that the slice may have holes that do not correspond
|
||
|
|
to any sample in the image represented by it.</p>
|
||
|
|
</div><h4 id='method.image_mut_slice' class="method"><code id='image_mut_slice.v'>pub fn <a href='#method.image_mut_slice' class='fnname'>image_mut_slice</a><T>(&mut 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">&mut [T]</a>> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#691-703' title='goto source code'>[src]</a></h4><div class='docblock'><p>Mutable portion of the buffer that holds sample values.</p>
|
||
|
|
</div><h4 id='method.try_into_buffer' class="method"><code id='try_into_buffer.v'>pub fn <a href='#method.try_into_buffer' class='fnname'>try_into_buffer</a><P>(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="struct" href="../../image/struct.ImageBuffer.html" title="struct image::ImageBuffer">ImageBuffer</a><P, Buffer>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="enum" href="../../image/flat/enum.Error.html" title="enum image::flat::Error">Error</a>, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> <span class="where fmt-newline">where<br> P: <a class="trait" href="../../image/trait.Pixel.html" title="trait image::Pixel">Pixel</a> + 'static,<br> P::<a class="type" href="../../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>: 'static,<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/deref/trait.Deref.html" title="trait core::ops::deref::Deref">Deref</a><Target = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[</a>P::<a class="type" href="../../image/trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>>, </span></code><a class='srclink' href='../../src/image/flat.rs.html#710-731' title='goto source code'>[src]</a></h4><div class='docblock'><p>Move the data into an image buffer.</p>
|
||
|
|
<p>This does <strong>not</strong> convert the sample layout. The buffer needs to be in packed row-major form
|
||
|
|
before calling this function. In case of an error, returns the buffer again so that it does
|
||
|
|
not release any allocation.</p>
|
||
|
|
</div><h4 id='method.min_length' class="method"><code id='min_length.v'>pub fn <a href='#method.min_length' class='fnname'>min_length</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><a class='srclink' href='../../src/image/flat.rs.html#784-786' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the minimum length of a buffer such that all in-bounds samples have valid indices.</p>
|
||
|
|
<p>This method will allow zero strides, allowing compact representations of monochrome images.
|
||
|
|
To check that no aliasing occurs, try <code>check_alias_invariants</code>. For compact images (no
|
||
|
|
aliasing and no unindexed samples) this is <code>width*height*channels</code>. But for both of the
|
||
|
|
other cases, the reasoning is slightly more involved.</p>
|
||
|
|
<h1 id="explanation" class="section-header"><a href="#explanation">Explanation</a></h1>
|
||
|
|
<p>Note that there is a difference between <code>min_length</code> and the index of the sample
|
||
|
|
'one-past-the-end`. This is due to strides that may be larger than the dimension below.</p>
|
||
|
|
<h2 id="example-with-holes" class="section-header"><a href="#example-with-holes">Example with holes</a></h2>
|
||
|
|
<p>Let's look at an example of a grayscale image with </p>
|
||
|
|
<ul>
|
||
|
|
<li><code>width_stride = 1</code></li>
|
||
|
|
<li><code>width = 2</code></li>
|
||
|
|
<li><code>height_stride = 3</code></li>
|
||
|
|
<li><code>height = 2</code></li>
|
||
|
|
</ul>
|
||
|
|
<pre><code class="language-text">| x x | x x m | $
|
||
|
|
min_length m ^
|
||
|
|
^ one-past-the-end $
|
||
|
|
</code></pre>
|
||
|
|
<p>The difference is also extreme for empty images with large strides. The one-past-the-end
|
||
|
|
sample index is still as large as the largest of these strides while <code>min_length = 0</code>.</p>
|
||
|
|
<h2 id="example-with-aliasing" class="section-header"><a href="#example-with-aliasing">Example with aliasing</a></h2>
|
||
|
|
<p>The concept gets even more important when you allow samples to alias each other. Here we
|
||
|
|
have the buffer of a small grayscale image where this is the case, this time we will first
|
||
|
|
show the buffer and then the individual rows below.</p>
|
||
|
|
<ul>
|
||
|
|
<li><code>width_stride = 1</code></li>
|
||
|
|
<li><code>width = 3</code></li>
|
||
|
|
<li><code>height_stride = 2</code></li>
|
||
|
|
<li><code>height = 2</code></li>
|
||
|
|
</ul>
|
||
|
|
<pre><code class="language-text"> 1 2 3 4 5 m
|
||
|
|
|1 2 3| row one
|
||
|
|
|3 4 5| row two
|
||
|
|
^ m min_length
|
||
|
|
^ ??? one-past-the-end
|
||
|
|
</code></pre>
|
||
|
|
<p>This time 'one-past-the-end' is not even simply the largest stride times the extent of its
|
||
|
|
dimension. That still points inside the image because <code>height*height_stride = 4</code> but also
|
||
|
|
<code>index_of(1, 2) = 4</code>.</p>
|
||
|
|
</div><h4 id='method.fits' class="method"><code id='fits.v'>pub fn <a href='#method.fits' class='fnname'>fits</a>(&self, len: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/image/flat.rs.html#789-791' title='goto source code'>[src]</a></h4><div class='docblock'><p>Check if a buffer of length <code>len</code> is large enough.</p>
|
||
|
|
</div><h4 id='method.has_aliased_samples' class="method"><code id='has_aliased_samples.v'>pub fn <a href='#method.has_aliased_samples' class='fnname'>has_aliased_samples</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/image/flat.rs.html#798-800' title='goto source code'>[src]</a></h4><div class='docblock'><p>If there are any samples aliasing each other.</p>
|
||
|
|
<p>If this is not the case, it would always be safe to allow mutable access to two different
|
||
|
|
samples at the same time. Otherwise, this operation would need additional checks. When one
|
||
|
|
dimension overflows <code>usize</code> with its stride we also consider this aliasing.</p>
|
||
|
|
</div><h4 id='method.is_normal' class="method"><code id='is_normal.v'>pub fn <a href='#method.is_normal' class='fnname'>is_normal</a>(&self, form: <a class="enum" href="../../image/flat/enum.NormalForm.html" title="enum image::flat::NormalForm">NormalForm</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/image/flat.rs.html#809-811' title='goto source code'>[src]</a></h4><div class='docblock'><p>Check if a buffer fulfills the requirements of a normal form.</p>
|
||
|
|
<p>Certain conversions have preconditions on the structure of the sample buffer that are not
|
||
|
|
captured (by design) by the type system. These are then checked before the conversion. Such
|
||
|
|
checks can all be done in constant time and will not inspect the buffer content. You can
|
||
|
|
perform these checks yourself when the conversion is not required at this moment but maybe
|
||
|
|
still performed later.</p>
|
||
|
|
</div><h4 id='method.in_bounds' class="method"><code id='in_bounds.v'>pub fn <a href='#method.in_bounds' class='fnname'>in_bounds</a>(&self, channel: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../../src/image/flat.rs.html#818-820' title='goto source code'>[src]</a></h4><div class='docblock'><p>Check that the pixel and the channel index are in bounds.</p>
|
||
|
|
<p>An in-bound coordinate does not yet guarantee that the corresponding calculation of a
|
||
|
|
buffer index does not overflow. However, if such a buffer large enough to hold all samples
|
||
|
|
actually exists in memory, this porperty of course follows.</p>
|
||
|
|
</div><h4 id='method.index' class="method"><code id='index.v'>pub fn <a href='#method.index' class='fnname'>index</a>(&self, channel: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>></code><a class='srclink' href='../../src/image/flat.rs.html#825-827' title='goto source code'>[src]</a></h4><div class='docblock'><p>Resolve the index of a particular sample.</p>
|
||
|
|
<p><code>None</code> if the index is outside the bounds or does not fit into a <code>usize</code>.</p>
|
||
|
|
</div><h4 id='method.index_ignoring_bounds' class="method"><code id='index_ignoring_bounds.v'>pub fn <a href='#method.index_ignoring_bounds' class='fnname'>index_ignoring_bounds</a>(<br> &self, <br> channel: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <br> y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a><br>) -> <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><a class='srclink' href='../../src/image/flat.rs.html#834-836' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the theoretical position of sample (x, y, channel).</p>
|
||
|
|
<p>The 'check' is for overflow during index calculation, not that it is contained in the
|
||
|
|
image. Two samples may return the same index, even when one of them is out of bounds. This
|
||
|
|
happens when all strides are <code>0</code>, i.e. the image is an arbitrarily large monochrome image.</p>
|
||
|
|
</div><h4 id='method.in_bounds_index' class="method"><code id='in_bounds_index.v'>pub fn <a href='#method.in_bounds_index' class='fnname'>in_bounds_index</a>(&self, channel: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, x: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../../src/image/flat.rs.html#843-845' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get an index provided it is inbouds.</p>
|
||
|
|
<p>Assumes that the image is backed by some sufficiently large buffer. Then computation can
|
||
|
|
not overflow as we could represent the maximum coordinate. Since overflow is defined either
|
||
|
|
way, this method can not be unsafe.</p>
|
||
|
|
</div><h4 id='method.shrink_to' class="method"><code id='shrink_to.v'>pub fn <a href='#method.shrink_to' class='fnname'>shrink_to</a>(&mut self, channels: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>, width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>)</code><a class='srclink' href='../../src/image/flat.rs.html#852-854' title='goto source code'>[src]</a></h4><div class='docblock'><p>Shrink the image to the minimum of current and given extents.</p>
|
||
|
|
<p>This does not modify the strides, so that the resulting sample buffer may have holes
|
||
|
|
created by the shrinking operation. Shrinking could also lead to an non-aliasing image when
|
||
|
|
samples had aliased each other before.</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-Clone' class='impl'><code class='in-band'>impl<Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>> <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#64' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></code><a class='srclink' href='../../src/image/flat.rs.html#64' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
|
|
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Index%3C(u8%2C%20u32%2C%20u32)%3E' class='impl'><code class='in-band'>impl<Buffer> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><<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.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> for <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>, </span></code><a href='#impl-Index%3C(u8%2C%20u32%2C%20u32)%3E' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#1217-1234' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output' class="type"><code id='Output.t'>type <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output' class="type">Output</a> = Buffer::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a></code></h4><div class='docblock'><p>The returned type after indexing.</p>
|
||
|
|
</div><h4 id='method.index-1' class="method"><code id='index.v-1'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#tymethod.index' class='fnname'>index</a>(&self, (c, x, y): <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.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -> &Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a></code><a class='srclink' href='../../src/image/flat.rs.html#1227-1233' title='goto source code'>[src]</a></h4><div class='docblock'><p>Return a reference to a single sample at specified coordinates.</p>
|
||
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
|
|
<p>When the coordinates are out of bounds or the index calculation fails.</p>
|
||
|
|
</div></div><h3 id='impl-IndexMut%3C(u8%2C%20u32%2C%20u32)%3E' class='impl'><code class='in-band'>impl<Buffer> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.IndexMut.html" title="trait core::ops::index::IndexMut">IndexMut</a><<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.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>> for <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.IndexMut.html" title="trait core::ops::index::IndexMut">IndexMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>>, </span></code><a href='#impl-IndexMut%3C(u8%2C%20u32%2C%20u32)%3E' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#1236-1252' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.index_mut' class="method"><code id='index_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.IndexMut.html#tymethod.index_mut' class='fnname'>index_mut</a>(&mut self, (c, x, y): <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.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>) -> &mut Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a></code><a class='srclink' href='../../src/image/flat.rs.html#1245-1251' title='goto source code'>[src]</a></h4><div class='docblock'><p>Return a mutable reference to a single sample at specified coordinates.</p>
|
||
|
|
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
||
|
|
<p>When the coordinates are out of bounds or the index calculation fails.</p>
|
||
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl<Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <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="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#64' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../../src/image/flat.rs.html#64' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></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'><code class='in-band'>impl<Buffer> <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/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer> <span class="where fmt-newline">where<br> Buffer: <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></h3><div class='impl-items'></div><h3 id='impl-Unpin' class='impl'><code class='in-band'>impl<Buffer> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<Buffer> <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/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer> <span class="where fmt-newline">where<br> Buffer: <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></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<Buffer> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl<Buffer> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../../image/flat/struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer> <span class="where fmt-newline">where<br> Buffer: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>, </span></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clo
|
||
|
|
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&self) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
|
|
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||
|
|
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#544-549' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#553-555' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(t: T) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#554' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#572-578' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#575-577' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#560-567' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#564-566' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-SetParameter' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../../gif/traits/trait.SetParameter.html" title="trait gif::traits::SetParameter">SetParameter</a> for T</code><a href='#impl-SetParameter' class='anchor'></a><a class='srclink' href='../../src/gif/traits.rs.html#25' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.set' class="method hidden"><code id='set.v'>fn <a href='../../gif/traits/trait.SetParameter.html#method.set' class='fnname'>set</a><T>(&mut self, value: T) -> <T as <a class="trait" href="../../gif/traits/trait.Parameter.html" title="trait gif::traits::Parameter">Parameter</a><Self>>::<a class="type" href="../../gif/traits/trait.Parameter.html#associatedtype.Result" title="type gif::traits::Parameter::Result">Result</a> <span class="where fmt-newline">where<br> T: <a class="trait" href="../../gif/traits/trait.Parameter.html" title="trait gif::traits::Parameter">Parameter</a><Self>, </span></code><a class='srclink' href='../../src/gif/traits.rs.html#20-22' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Sets <code>value</code> as a parameter of <code>self</code>.</p>
|
||
|
|
</div></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>
|