|
|
<!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 `SampleLayout` struct in crate `image`."><meta name="keywords" content="rust, rustlang, rust-lang, SampleLayout"><title>image::flat::SampleLayout - 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 SampleLayout</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#fields">Fields</a><div class="sidebar-links"><a href="#structfield.channels">channels</a><a href="#structfield.channel_stride">channel_stride</a><a href="#structfield.width">width</a><a href="#structfield.width_stride">width_stride</a><a href="#structfield.height">height</a><a href="#structfield.height_stride">height_stride</a></div><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.bounds">bounds</a><a href="#method.column_major_packed">column_major_packed</a><a href="#method.extents">extents</a><a href="#method.fits">fits</a><a href="#method.has_aliased_samples">has_aliased_samples</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.row_major_packed">row_major_packed</a><a href="#method.shrink_to">shrink_to</a><a href="#method.strides_cwh">strides_cwh</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-Hash">Hash</a><a href="#impl-PartialEq%3CSampleLayout%3E">PartialEq<SampleLayout></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: 'SampleLayout', 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"><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/flat.rs.html#84-102' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>image</a>::<wbr><a href='index.html'>flat</a>::<wbr><a class="struct" href=''>SampleLayout</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'><span class="docblock attributes top-attr">#[repr(C)]
|
|
|
</span>pub struct SampleLayout {
|
|
|
pub channels: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>,
|
|
|
pub channel_stride: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
|
|
|
pub width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
|
|
pub width_stride: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
|
|
|
pub height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>,
|
|
|
pub height_stride: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>,
|
|
|
}</pre></div><div class='docblock'><p>A ffi compatible description of a sample buffer.</p>
|
|
|
</div><h2 id='fields' class='fields small-section-header'>
|
|
|
Fields<a href='#fields' class='anchor'></a></h2><span id="structfield.channels" class="structfield small-section-header"><a href="#structfield.channels" class="anchor field"></a><code id="channels.v">channels: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a></code></span><div class='docblock'><p>The number of channels in the color representation of the image.</p>
|
|
|
</div><span id="structfield.channel_stride" class="structfield small-section-header"><a href="#structfield.channel_stride" class="anchor field"></a><code id="channel_stride.v">channel_stride: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><div class='docblock'><p>Add this to an index to get to the sample in the next channel.</p>
|
|
|
</div><span id="structfield.width" class="structfield small-section-header"><a href="#structfield.width" class="anchor field"></a><code id="width.v">width: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span><div class='docblock'><p>The width of the represented image.</p>
|
|
|
</div><span id="structfield.width_stride" class="structfield small-section-header"><a href="#structfield.width_stride" class="anchor field"></a><code id="width_stride.v">width_stride: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><div class='docblock'><p>Add this to an index to get to the next sample in x-direction.</p>
|
|
|
</div><span id="structfield.height" class="structfield small-section-header"><a href="#structfield.height" class="anchor field"></a><code id="height.v">height: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span><div class='docblock'><p>The height of the represented image.</p>
|
|
|
</div><span id="structfield.height_stride" class="structfield small-section-header"><a href="#structfield.height_stride" class="anchor field"></a><code id="height_stride.v">height_stride: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><div class='docblock'><p>Add this to an index to get to the next sample in y-direction.</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 <a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#108-419' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.row_major_packed' class="method"><code id='row_major_packed.v'>pub fn <a href='#method.row_major_packed' class='fnname'>row_major_packed</a>(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>) -> Self</code><a class='srclink' href='../../src/image/flat.rs.html#125-136' title='goto source code'>[src]</a></h4><div class='docblock'><p>Describe a row-major image packed in all directions.</p>
|
|
|
<p>The resulting will surely be <code>NormalForm::RowMajorPacked</code>. It can therefore be converted to
|
|
|
safely to an <code>ImageBuffer</code> with a large enough underlying buffer.</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">let</span> <span class="ident">layout</span> <span class="op">=</span> <span class="ident">SampleLayout</span>::<span class="ident">row_major_packed</span>(<span class="number">3</span>, <span class="number">640</span>, <span class="number">480</span>);
|
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">layout</span>.<span class="ident">is_normal</span>(<span class="ident">NormalForm</span>::<span class="ident">RowMajorPacked</span>));</pre></div>
|
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
|
|
<p>On platforms where <code>usize</code> has the same size as <code>u32</code> this panics when the resulting stride
|
|
|
in the <code>height</code> direction would be larger than <code>usize::max_value()</code>. On other platforms
|
|
|
where it can surely accomodate `u8::max_value() * u32::max_value(), this can never happen.</p>
|
|
|
</div><h4 id='method.column_major_packed' class="method"><code id='column_major_packed.v'>pub fn <a href='#method.column_major_packed' class='fnname'>column_major_packed</a>(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>) -> Self</code><a class='srclink' href='../../src/image/flat.rs.html#154-165' title='goto source code'>[src]</a></h4><div class='docblock'><p>Describe a column-major image packed in all directions.</p>
|
|
|
<p>The resulting will surely be <code>NormalForm::ColumnMajorPacked</code>. This is not particularly
|
|
|
useful for conversion but can be used to describe such a buffer without pitfalls.</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">let</span> <span class="ident">layout</span> <span class="op">=</span> <span class="ident">SampleLayout</span>::<span class="ident">column_major_packed</span>(<span class="number">3</span>, <span class="number">640</span>, <span class="number">480</span>);
|
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">layout</span>.<span class="ident">is_normal</span>(<span class="ident">NormalForm</span>::<span class="ident">ColumnMajorPacked</span>));</pre></div>
|
|
|
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
|
|
<p>On platforms where <code>usize</code> has the same size as <code>u32</code> this panics when the resulting stride
|
|
|
in the <code>width</code> direction would be larger than <code>usize::max_value()</code>. On other platforms
|
|
|
where it can surely accomodate `u8::max_value() * u32::max_value(), this can never happen.</p>
|
|
|
</div><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#171-173' 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#179-181' 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#187-189' 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.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#242-249' 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#252-254' 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#277-298' 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#307-355' 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#362-364' 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#369-375' 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#382-396' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the theoretical position of sample (channel, x, y).</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, c: <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#403-406' 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#414-418' 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-Eq' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></code><a href='#impl-Eq' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#83' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Clone' class='impl'><code class='in-band'>impl <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.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#83' 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.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></code><a class='srclink' href='../../src/image/flat.rs.html#83' 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-PartialEq%3CSampleLayout%3E' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a><<a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a>> for <a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></code><a href='#impl-PartialEq%3CSampleLayout%3E' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#83' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.eq' class="method hidden"><code id='eq.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&self, other: &<a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</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#83' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
|
|
|
</div><h4 id='method.ne' class="method hidden"><code id='ne.v'>fn <a href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&self, other: &<a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</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#83' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
|
|
|
</div></div><h3 id='impl-Copy' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></code><a href='#impl-Copy' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#83' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Hash' class='impl'><code class='in-band'>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="../../image/flat/struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></code><a href='#impl-Hash' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#83' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.hash' class="method hidden"><code id='hash.v'>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash' class='fnname'>hash</a><__H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>__H)</code><a class='srclink' href='../../src/image/flat.rs.html#83' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Feeds this value into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#tymethod.hash">Read more</a></p>
|
|
|
</div><h4 id='method.hash_slice' class="method hidden"><code id='hash_slice.v'>fn <a href='https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice' class='fnname'>hash_slice</a><H>(data: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&[Self]</a>, state: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>H) <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>, </span></code><span class='since' title='Stable since Rust version 1.3.0'>1.3.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/hash/mod.rs.html#192-198' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Feeds a slice of this type into the given [<code>Hasher</code>]. <a href="https://doc.rust-lang.org/nightly/core/hash/trait.Hash.html#method.hash_slice">Read more</a></p>
|
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <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.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/image/flat.rs.html#83' 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#83' 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 <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.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></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 <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.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></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 <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.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></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 <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.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></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 <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.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></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::Clone">Clone</a>, </span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
|
|
</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> |
