| <!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="A flat buffer over a (multi channel) image."><meta name="keywords" content="rust, rustlang, rust-lang, FlatSamples"><title>FlatSamples in image::flat - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../image/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">FlatSamples</a></h2><div class="sidebar-elems"><section><h3><a href="#fields">Fields</a></h3><ul class="block"><li><a href="#structfield.color_hint">color_hint</a></li><li><a href="#structfield.layout">layout</a></li><li><a href="#structfield.samples">samples</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.as_mut">as_mut</a></li><li><a href="#method.as_mut_slice">as_mut_slice</a></li><li><a href="#method.as_ref">as_ref</a></li><li><a href="#method.as_slice">as_slice</a></li><li><a href="#method.as_view">as_view</a></li><li><a href="#method.as_view_mut">as_view_mut</a></li><li><a href="#method.as_view_with_mut_samples">as_view_with_mut_samples</a></li><li><a href="#method.bounds">bounds</a></li><li><a href="#method.extents">extents</a></li><li><a href="#method.fits">fits</a></li><li><a href="#method.get_mut_sample">get_mut_sample</a></li><li><a href="#method.get_sample">get_sample</a></li><li><a href="#method.has_aliased_samples">has_aliased_samples</a></li><li><a href="#method.image_mut_slice">image_mut_slice</a></li><li><a href="#method.image_slice">image_slice</a></li><li><a href="#method.in_bounds">in_bounds</a></li><li><a href="#method.in_bounds_index">in_bounds_index</a></li><li><a href="#method.index">index</a></li><li><a href="#method.index_ignoring_bounds">index_ignoring_bounds</a></li><li><a href="#method.is_normal">is_normal</a></li><li><a href="#method.min_length">min_length</a></li><li><a href="#method.shrink_to">shrink_to</a></li><li><a href="#method.strides_cwh">strides_cwh</a></li><li><a href="#method.to_vec">to_vec</a></li><li><a href="#method.try_into_buffer">try_into_buffer</a></li><li><a href="#method.with_monocolor">with_monocolor</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-FlatSamples%3CBuffer%3E">Clone</a></li><li><a href="#impl-Debug-for-FlatSamples%3CBuffer%3E">Debug</a></li><li><a href="#impl-Index%3C(u8%2C%20u32%2C%20u32)%3E-for-FlatSamples%3CBuffer%3E">Index<(u8, u32, u32)></a></li><li><a href="#impl-IndexMut%3C(u8%2C%20u32%2C%20u32)%3E-for-FlatSamples%3CBuffer%3E">IndexMut<(u8, u32, u32)></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-FlatSamples%3CBuffer%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-FlatSamples%3CBuffer%3E">Send</a></li><li><a href="#impl-Sync-for-FlatSamples%3CBuffer%3E">Sync</a></li><li><a href="#impl-Unpin-for-FlatSamples%3CBuffer%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-FlatSamples%3CBuffer%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-FlatSamples%3CBuffer%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-FlatSamples%3CBuffer%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-FlatSamples%3CBuffer%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-FlatSamples%3CBuffer%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-FlatSamples%3CBuffer%3E">Into<U></a></li><li><a href="#impl-ToOwned-for-FlatSamples%3CBuffer%3E">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-FlatSamples%3CBuffer%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-FlatSamples%3CBuffer%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In image::flat</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Struct <a href="../index.html">image</a>::<wbr><a href="index.html">flat</a>::<wbr><a class="struct" href="#">FlatSamples</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/image/flat.rs.html#81-95">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct FlatSamples<Buffer> { |
| pub samples: Buffer, |
| pub layout: <a class="struct" href="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="../enum.ColorType.html" title="enum image::ColorType">ColorType</a>>, |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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. It also allows grouping by color planes instead of by pixel as long as |
| the strides of each extent are constant. This struct itself has no invariants on the strides |
| but not every possible configuration can be interpreted as a <a href="../trait.GenericImageView.html"><code>GenericImageView</code></a> or |
| <a href="../trait.GenericImage.html"><code>GenericImage</code></a>. The methods <a href="#method.as_view"><code>as_view</code></a> and <a href="#method.as_view_mut"><code>as_view_mut</code></a> construct the actual implementors |
| of these traits and perform necessary checks. To manually perform this and other layout checks |
| use <a href="#method.is_normal"><code>is_normal</code></a> or <a href="#method.has_aliased_samples"><code>has_aliased_samples</code></a>.</p> |
| <p>Instances can be constructed not only by hand. The buffer instances returned by library |
| functions such as <a href="../struct.ImageBuffer.html#method.as_flat_samples"><code>ImageBuffer::as_flat_samples</code></a> guarantee that the conversion to a generic |
| image or generic view succeeds. A very different constructor is <a href="#method.with_monocolor"><code>with_monocolor</code></a>. It uses a |
| single pixel as the backing storage for an arbitrarily sized read-only raster by mapping each |
| pixel to the same samples by setting some strides to <code>0</code>.</p> |
| </div></details><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>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>layout: <a class="struct" href="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>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="../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="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#452-871">source</a><a href="#impl-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">impl<Buffer> <a class="struct" href="struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.strides_cwh" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#457-459">source</a><h4 class="code-header">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.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>)</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.extents" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#465-467">source</a><h4 class="code-header">pub fn <a href="#method.extents" class="fnname">extents</a>(&self) -> (<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>)</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.bounds" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#473-475">source</a><h4 class="code-header">pub fn <a href="#method.bounds" class="fnname">bounds</a>(&self) -> (<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>)</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_ref" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#478-484">source</a><h4 class="code-header">pub fn <a href="#method.as_ref" class="fnname">as_ref</a><T>(&self) -> <a class="struct" href="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">[T]</a>>,</span></h4></section></summary><div class="docblock"><p>Get a reference based version.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#487-493">source</a><h4 class="code-header">pub fn <a href="#method.as_mut" class="fnname">as_mut</a><T>(&mut self) -> <a class="struct" href="struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><&mut <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.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[T]</a>>,</span></h4></section></summary><div class="docblock"><p>Get a mutable reference based version.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_vec" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#496-504">source</a><h4 class="code-header">pub fn <a href="#method.to_vec" class="fnname">to_vec</a><T>(&self) -> <a class="struct" href="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">[T]</a>>,</span></h4></section></summary><div class="docblock"><p>Copy the data into an owned vector.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_sample" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#527-531">source</a><h4 class="code-header">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">[T]</a>>,</span></h4></section></summary><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"><code><span class="kw">let </span>flat = RgbImage::new(<span class="number">480</span>, <span class="number">640</span>).into_flat_samples(); |
| |
| <span class="comment">// Get the blue channel at (10, 10). |
| </span><span class="macro">assert!</span>(flat.get_sample(<span class="number">1</span>, <span class="number">10</span>, <span class="number">10</span>).is_some()); |
| |
| <span class="comment">// There is no alpha channel. |
| </span><span class="macro">assert!</span>(flat.get_sample(<span class="number">3</span>, <span class="number">10</span>, <span class="number">10</span>).is_none());</code></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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.get_mut_sample" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#560-567">source</a><h4 class="code-header">pub fn <a href="#method.get_mut_sample" class="fnname">get_mut_sample</a><T>(&mut 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">&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">[T]</a>>,</span></h4></section></summary><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"><code><span class="kw">let </span><span class="kw-2">mut </span>flat = RgbImage::new(<span class="number">480</span>, <span class="number">640</span>).into_flat_samples(); |
| |
| <span class="comment">// Assign some new color to the blue channel at (10, 10). |
| </span><span class="kw-2">*</span>flat.get_mut_sample(<span class="number">1</span>, <span class="number">10</span>, <span class="number">10</span>).unwrap() = <span class="number">255</span>; |
| |
| <span class="comment">// There is no alpha channel. |
| </span><span class="macro">assert!</span>(flat.get_mut_sample(<span class="number">3</span>, <span class="number">10</span>, <span class="number">10</span>).is_none());</code></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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_view" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#575-595">source</a><h4 class="code-header">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="struct.View.html" title="struct image::flat::View">View</a><&[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>], P>, <a class="enum" href="enum.Error.html" title="enum image::flat::Error">Error</a>><span class="where fmt-newline">where<br> P: <a class="trait" href="../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><[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_view_with_mut_samples" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#612-632">source</a><h4 class="code-header">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="struct.View.html" title="struct image::flat::View">View</a><&mut [P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>], P>, <a class="enum" href="enum.Error.html" title="enum image::flat::Error">Error</a>><span class="where fmt-newline">where<br> P: <a class="trait" href="../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><[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_view_mut" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#645-669">source</a><h4 class="code-header">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="struct.ViewMut.html" title="struct image::flat::ViewMut">ViewMut</a><&mut [P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>], P>, <a class="enum" href="enum.Error.html" title="enum image::flat::Error">Error</a>><span class="where fmt-newline">where<br> P: <a class="trait" href="../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><[P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_slice" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#675-677">source</a><h4 class="code-header">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="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span></code></span></span></span></span><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">[T]</a>>,</span></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.as_mut_slice" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#683-685">source</a><h4 class="code-header">pub fn <a href="#method.as_mut_slice" class="fnname">as_mut_slice</a><T>(&mut self) -> &mut <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[T]</a><span class="notable-traits"><span class="notable-traits-tooltip">ⓘ<span class="notable-traits-tooltiptext"><span class="docblock"><span class="notable">Notable traits for &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span><code class="content"><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a> for &[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span><span class="where fmt-newline">impl <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Write.html" title="trait std::io::Write">Write</a> for &mut [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a>]</span></code></span></span></span></span><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">[T]</a>>,</span></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.image_slice" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#692-704">source</a><h4 class="code-header">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">[T]</a>>,</span></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.image_mut_slice" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#707-719">source</a><h4 class="code-header">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><&mut <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.AsMut.html" title="trait core::convert::AsMut">AsMut</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[T]</a>>,</span></h4></section></summary><div class="docblock"><p>Mutable portion of the buffer that holds sample values.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into_buffer" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#726-747">source</a><h4 class="code-header">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="../struct.ImageBuffer.html" title="struct image::ImageBuffer">ImageBuffer</a><P, Buffer>, (<a class="enum" href="enum.Error.html" title="enum image::flat::Error">Error</a>, Self)><span class="where fmt-newline">where<br> P: <a class="trait" href="../trait.Pixel.html" title="trait image::Pixel">Pixel</a> + 'static,<br> P::<a class="associatedtype" href="../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 = [P::<a class="associatedtype" href="../trait.Pixel.html#associatedtype.Subpixel" title="type image::Pixel::Subpixel">Subpixel</a>]>,</span></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.min_length" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#800-802">source</a><h4 class="code-header">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>></h4></section></summary><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> |
| <h5 id="explanation"><a href="#explanation">Explanation</a></h5> |
| <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> |
| <h6 id="example-with-holes"><a href="#example-with-holes">Example with holes</a></h6> |
| <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> |
| <div class="example-wrap"><pre class="language-text"><code>| x x | x x m | $ |
| min_length m ^ |
| ^ one-past-the-end $</code></pre></div> |
| <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> |
| <h6 id="example-with-aliasing"><a href="#example-with-aliasing">Example with aliasing</a></h6> |
| <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> |
| <div class="example-wrap"><pre class="language-text"><code> 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></div> |
| <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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fits" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#805-807">source</a><h4 class="code-header">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></h4></section></summary><div class="docblock"><p>Check if a buffer of length <code>len</code> is large enough.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.has_aliased_samples" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#814-816">source</a><h4 class="code-header">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></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_normal" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#825-827">source</a><h4 class="code-header">pub fn <a href="#method.is_normal" class="fnname">is_normal</a>(&self, form: <a class="enum" href="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></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_bounds" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#834-836">source</a><h4 class="code-header">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></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.index" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#841-843">source</a><h4 class="code-header">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>></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.index_ignoring_bounds" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#850-852">source</a><h4 class="code-header">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>></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.in_bounds_index" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#859-861">source</a><h4 class="code-header">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></h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.shrink_to" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#868-870">source</a><h4 class="code-header">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>)</h4></section></summary><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></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-FlatSamples%3C%26%27buf%20%5BSubpixel%5D%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#873-912">source</a><a href="#impl-FlatSamples%3C%26%27buf%20%5BSubpixel%5D%3E" class="anchor"></a><h3 class="code-header">impl<'buf, Subpixel> <a class="struct" href="struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><&'buf <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">[Subpixel]</a>></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.with_monocolor" class="method has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#894-911">source</a><h4 class="code-header">pub fn <a href="#method.with_monocolor" class="fnname">with_monocolor</a><P>(pixel: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'buf </a>P, 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<span class="where fmt-newline">where<br> P: <a class="trait" href="../trait.Pixel.html" title="trait image::Pixel">Pixel</a><Subpixel = Subpixel>,<br> Subpixel: <a class="trait" href="../trait.Primitive.html" title="trait image::Primitive">Primitive</a>,</span></h4></section></summary><div class="docblock"><p>Create a monocolor image from a single pixel.</p> |
| <p>This can be used as a very cheap source of a <code>GenericImageView</code> with an arbitrary number of |
| pixels of a single color, without any dynamic allocation.</p> |
| <h6 id="examples"><a href="#examples">Examples</a></h6> |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>image::{flat::FlatSamples, GenericImage, RgbImage, Rgb}; |
| |
| <span class="kw">let </span>background = Rgb([<span class="number">20</span>, <span class="number">20</span>, <span class="number">20</span>]); |
| <span class="kw">let </span>bg = FlatSamples::with_monocolor(<span class="kw-2">&</span>background, <span class="number">200</span>, <span class="number">200</span>);; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>image = RgbImage::new(<span class="number">200</span>, <span class="number">200</span>); |
| paint_something(<span class="kw-2">&mut </span>image); |
| |
| <span class="comment">// Reset the canvas |
| </span>image.copy_from(<span class="kw-2">&</span>bg.as_view().unwrap(), <span class="number">0</span>, <span class="number">0</span>);</code></pre></div> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Clone-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#80">source</a><a href="#impl-Clone-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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="struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#80">source</a><a href="#method.clone" class="anchor"></a><h4 class="code-header">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="struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl has-srclink"><span class="rightside"><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#132-134">source</a></span><a href="#method.clone_from" class="anchor"></a><h4 class="code-header">const 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)</h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#80">source</a><a href="#impl-Debug-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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="struct.FlatSamples.html" title="struct image::flat::FlatSamples">FlatSamples</a><Buffer></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#80">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">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></h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Index%3C(u8%2C%20u32%2C%20u32)%3E-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1275-1292">source</a><a href="#impl-Index%3C(u8%2C%20u32%2C%20u32)%3E-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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.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>)> for <a class="struct" href="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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.index-1" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1285-1291">source</a><a href="#method.index-1" class="anchor"></a><h4 class="code-header">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.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>)) -> &Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a></h4></section></summary><div class="docblock"><p>Return a reference to a single sample at specified coordinates.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>When the coordinates are out of bounds or the index calculation fails.</p> |
| </div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" class="associatedtype">Output</a> = <Buffer as <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>>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a></h4></section></summary><div class='docblock'>The returned type after indexing.</div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-IndexMut%3C(u8%2C%20u32%2C%20u32)%3E-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1294-1310">source</a><a href="#impl-IndexMut%3C(u8%2C%20u32%2C%20u32)%3E-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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.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>)> for <a class="struct" href="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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.index_mut" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/image/flat.rs.html#1303-1309">source</a><a href="#method.index_mut" class="anchor"></a><h4 class="code-header">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.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>)) -> &mut Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a></h4></section></summary><div class="docblock"><p>Return a mutable reference to a single sample at specified coordinates.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>When the coordinates are out of bounds or the index calculation fails.</p> |
| </div></details></div></details></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"><section id="impl-RefUnwindSafe-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">impl<Buffer> <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="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/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</span></h3></section><section id="impl-Send-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a href="#impl-Send-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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="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></h3></section><section id="impl-Sync-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a href="#impl-Sync-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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="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></h3></section><section id="impl-Unpin-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a href="#impl-Unpin-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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="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></h3></section><section id="impl-UnwindSafe-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">impl<Buffer> <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="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/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</span></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">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></h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">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</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">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</h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-ToOwned-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#83">source</a><a href="#impl-ToOwned-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Owned" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#88">source</a><a href="#method.to_owned" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fnname">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>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></div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#92">source</a><a href="#method.clone_into" class="anchor"></a><h4 class="code-header">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)</h4></section></summary><div class='docblock'>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></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">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="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-FlatSamples%3CBuffer%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-FlatSamples%3CBuffer%3E" class="anchor"></a><h3 class="code-header">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></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">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="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">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="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="image" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
