134 lines
54 KiB
HTML
134 lines
54 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A ffi compatible description of a sample buffer."><title>SampleLayout in image::flat - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="image" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../image/index.html">image</a><span class="version">0.25.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">Sample<wbr>Layout</a></h2><h3><a href="#fields">Fields</a></h3><ul class="block structfield"><li><a href="#structfield.channel_stride" title="channel_stride">channel_stride</a></li><li><a href="#structfield.channels" title="channels">channels</a></li><li><a href="#structfield.height" title="height">height</a></li><li><a href="#structfield.height_stride" title="height_stride">height_stride</a></li><li><a href="#structfield.width" title="width">width</a></li><li><a href="#structfield.width_stride" title="width_stride">width_stride</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.bounds" title="bounds">bounds</a></li><li><a href="#method.column_major_packed" title="column_major_packed">column_major_packed</a></li><li><a href="#method.extents" title="extents">extents</a></li><li><a href="#method.fits" title="fits">fits</a></li><li><a href="#method.has_aliased_samples" title="has_aliased_samples">has_aliased_samples</a></li><li><a href="#method.in_bounds" title="in_bounds">in_bounds</a></li><li><a href="#method.in_bounds_index" title="in_bounds_index">in_bounds_index</a></li><li><a href="#method.index" title="index">index</a></li><li><a href="#method.index_ignoring_bounds" title="index_ignoring_bounds">index_ignoring_bounds</a></li><li><a href="#method.is_normal" title="is_normal">is_normal</a></li><li><a href="#method.min_length" title="min_length">min_length</a></li><li><a href="#method.row_major_packed" title="row_major_packed">row_major_packed</a></li><li><a href="#method.shrink_to" title="shrink_to">shrink_to</a></li><li><a href="#method.strides_cwh" title="strides_cwh">strides_cwh</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-SampleLayout" title="Clone">Clone</a></li><li><a href="#impl-Copy-for-SampleLayout" title="Copy">Copy</a></li><li><a href="#impl-Debug-for-SampleLayout" title="Debug">Debug</a></li><li><a href="#impl-Eq-for-SampleLayout" title="Eq">Eq</a></li><li><a href="#impl-Hash-for-SampleLayout" title="Hash">Hash</a></li><li><a href="#impl-PartialEq-for-SampleLayout" title="PartialEq">PartialEq</a></li><li><a href="#impl-StructuralPartialEq-for-SampleLayout" title="StructuralPartialEq">StructuralPartialEq</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-SampleLayout" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-SampleLayout" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-SampleLayout" title="Send">Send</a></li><li><a href="#impl-Sync-for-SampleLayout" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-SampleLayout" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-SampleLayout" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-ToOwned-for-T" title="ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In image::<wbr>flat</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="../index.html">image</a>::<wbr><a href="index.html">flat</a></span><h1>Struct <span class="struct">SampleLayout</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/image/flat.rs.html#103-121">Source</a> </span></div><pre class="rust item-decl"><code><div class="code-attribute">#[repr(C)]</div>pub struct SampleLayout {
|
||
pub channels: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>,
|
||
pub channel_stride: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
pub width: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>,
|
||
pub width_stride: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
pub height: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>,
|
||
pub height_stride: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A ffi compatible description of a sample buffer.</p>
|
||
</div></details><h2 id="fields" class="fields section-header">Fields<a href="#fields" class="anchor">§</a></h2><span id="structfield.channels" class="structfield section-header"><a href="#structfield.channels" class="anchor field">§</a><code>channels: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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 section-header"><a href="#structfield.channel_stride" class="anchor field">§</a><code>channel_stride: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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 section-header"><a href="#structfield.width" class="anchor field">§</a><code>width: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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 section-header"><a href="#structfield.width_stride" class="anchor field">§</a><code>width_stride: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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 section-header"><a href="#structfield.height" class="anchor field">§</a><code>height: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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 section-header"><a href="#structfield.height_stride" class="anchor field">§</a><code>height_stride: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-SampleLayout" class="impl"><a class="src rightside" href="../../src/image/flat.rs.html#127-460">Source</a><a href="#impl-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.row_major_packed" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#145-157">Source</a><h4 class="code-header">pub fn <a href="#method.row_major_packed" class="fn">row_major_packed</a>(channels: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>, width: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> Self</h4></section></summary><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"><code><span class="kw">let </span>layout = SampleLayout::row_major_packed(<span class="number">3</span>, <span class="number">640</span>, <span class="number">480</span>);
|
||
<span class="macro">assert!</span>(layout.is_normal(NormalForm::RowMajorPacked));</code></pre></div>
|
||
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
||
<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</code>. On other platforms
|
||
where it can surely accommodate `u8::MAX * u32::MAX, this can never happen.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.column_major_packed" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#176-188">Source</a><h4 class="code-header">pub fn <a href="#method.column_major_packed" class="fn">column_major_packed</a>(channels: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>, width: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> Self</h4></section></summary><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"><code><span class="kw">let </span>layout = SampleLayout::column_major_packed(<span class="number">3</span>, <span class="number">640</span>, <span class="number">480</span>);
|
||
<span class="macro">assert!</span>(layout.is_normal(NormalForm::ColumnMajorPacked));</code></pre></div>
|
||
<h5 id="panics-1"><a class="doc-anchor" href="#panics-1">§</a>Panics</h5>
|
||
<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</code>. On other platforms
|
||
where it can surely accommodate `u8::MAX * u32::MAX, this can never happen.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.strides_cwh" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#195-197">Source</a><h4 class="code-header">pub fn <a href="#method.strides_cwh" class="fn">strides_cwh</a>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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="toggle method-toggle" open><summary><section id="method.extents" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#204-210">Source</a><h4 class="code-header">pub fn <a href="#method.extents" class="fn">extents</a>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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="toggle method-toggle" open><summary><section id="method.bounds" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#217-219">Source</a><h4 class="code-header">pub fn <a href="#method.bounds" class="fn">bounds</a>(&self) -> (<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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="toggle method-toggle" open><summary><section id="method.min_length" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#273-280">Source</a><h4 class="code-header">pub fn <a href="#method.min_length" class="fn">min_length</a>(&self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/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 class="doc-anchor" href="#explanation">§</a>Explanation</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 class="doc-anchor" href="#example-with-holes">§</a>Example with holes</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 class="doc-anchor" href="#example-with-aliasing">§</a>Example with aliasing</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="toggle method-toggle" open><summary><section id="method.fits" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#284-286">Source</a><h4 class="code-header">pub fn <a href="#method.fits" class="fn">fits</a>(&self, len: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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="toggle method-toggle" open><summary><section id="method.has_aliased_samples" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#311-332">Source</a><h4 class="code-header">pub fn <a href="#method.has_aliased_samples" class="fn">has_aliased_samples</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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="toggle method-toggle" open><summary><section id="method.is_normal" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#342-390">Source</a><h4 class="code-header">pub fn <a href="#method.is_normal" class="fn">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/1.84.0/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="toggle method-toggle" open><summary><section id="method.in_bounds" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#398-400">Source</a><h4 class="code-header">pub fn <a href="#method.in_bounds" class="fn">in_bounds</a>(&self, channel: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>, x: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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 property of course follows.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.index" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#406-412">Source</a><h4 class="code-header">pub fn <a href="#method.index" class="fn">index</a>(&self, channel: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>, x: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/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="toggle method-toggle" open><summary><section id="method.index_ignoring_bounds" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#420-434">Source</a><h4 class="code-header">pub fn <a href="#method.index_ignoring_bounds" class="fn">index_ignoring_bounds</a>(
|
||
&self,
|
||
channel: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
x: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
y: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>,
|
||
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>></h4></section></summary><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></details><details class="toggle method-toggle" open><summary><section id="method.in_bounds_index" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#445-448">Source</a><h4 class="code-header">pub fn <a href="#method.in_bounds_index" class="fn">in_bounds_index</a>(&self, c: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>, x: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, y: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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>
|
||
<p>Behavior is <em>unspecified</em> if the index is out of bounds or this sample layout would require
|
||
a buffer larger than <code>isize::MAX</code> bytes.</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.shrink_to" class="method"><a class="src rightside" href="../../src/image/flat.rs.html#455-459">Source</a><h4 class="code-header">pub fn <a href="#method.shrink_to" class="fn">shrink_to</a>(&mut self, channels: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>, width: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u32.html">u32</a>, height: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/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></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-SampleLayout" class="impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#impl-Clone-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#174">Source</a></span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-SampleLayout" class="impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#impl-Debug-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/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/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Hash-for-SampleLayout" class="impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#impl-Hash-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.hash" class="method trait-impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#method.hash" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html#tymethod.hash" class="fn">hash</a><__H: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>>(&self, state: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut __H</a>)</h4></section></summary><div class='docblock'>Feeds this value into the given <a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html#tymethod.hash">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.hash_slice" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.3.0">1.3.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/core/hash/mod.rs.html#235-237">Source</a></span><a href="#method.hash_slice" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html#method.hash_slice" class="fn">hash_slice</a><H>(data: &[Self], state: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut H</a>)<div class="where">where
|
||
H: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher">Hasher</a>,
|
||
Self: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class='docblock'>Feeds a slice of this type into the given <a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hasher.html" title="trait core::hash::Hasher"><code>Hasher</code></a>. <a href="https://doc.rust-lang.org/1.84.0/core/hash/trait.Hash.html#method.hash_slice">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-SampleLayout" class="impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#impl-PartialEq-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&self, other: &<a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.84.0/src/core/cmp.rs.html#261">Source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&self, other: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&Rhs</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>!=</code>. The default implementation is almost always sufficient,
|
||
and should not be overridden without very good reason.</div></details></div></details><section id="impl-Copy-for-SampleLayout" class="impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#impl-Copy-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section><section id="impl-Eq-for-SampleLayout" class="impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#impl-Eq-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section><section id="impl-StructuralPartialEq-for-SampleLayout" class="impl"><a class="src rightside" href="../../src/image/flat.rs.html#102">Source</a><a href="#impl-StructuralPartialEq-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.StructuralPartialEq.html" title="trait core::marker::StructuralPartialEq">StructuralPartialEq</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-SampleLayout" class="impl"><a href="#impl-Freeze-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section><section id="impl-RefUnwindSafe-for-SampleLayout" class="impl"><a href="#impl-RefUnwindSafe-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section><section id="impl-Send-for-SampleLayout" class="impl"><a href="#impl-Send-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section><section id="impl-Sync-for-SampleLayout" class="impl"><a href="#impl-Sync-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section><section id="impl-Unpin-for-SampleLayout" class="impl"><a href="#impl-Unpin-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section><section id="impl-UnwindSafe-for-SampleLayout" class="impl"><a href="#impl-UnwindSafe-for-SampleLayout" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.SampleLayout.html" title="struct image::flat::SampleLayout">SampleLayout</a></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
||
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/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/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
||
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#273">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#275">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dst: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dst</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">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/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#82-84">Source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
||
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#86">Source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/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="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#87">Source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">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/1.84.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#91">Source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/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="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/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="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
||
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/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="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/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></body></html> |