Sophie

Sophie

distrib > Mageia > 7 > armv7hl > media > core-release > by-pkgid > 0c2243f8a1696816431e7210e991fa52 > files > 1149

rust-doc-1.35.0-1.mga7.armv7hl.rpm

<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="API documentation for the Rust `Layout` struct in crate `core`."><meta name="keywords" content="rust, rustlang, rust-lang, Layout"><title>core::alloc::Layout - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize1.35.0.css"><link rel="stylesheet" type="text/css" href="../../rustdoc1.35.0.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark1.35.0.css"><link rel="stylesheet" type="text/css" href="../../light1.35.0.css" id="themeStyle"><script src="../../storage1.35.0.js"></script><noscript><link rel="stylesheet" href="../../noscript1.35.0.css"></noscript><link rel="shortcut icon" href="../../favicon1.35.0.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow1.35.0.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../core/index.html'><img src='../../rust-logo1.35.0.png' alt='logo' width='100'></a><p class='location'>Struct Layout</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.align">align</a><a href="#method.align_to">align_to</a><a href="#method.array">array</a><a href="#method.extend">extend</a><a href="#method.extend_packed">extend_packed</a><a href="#method.for_value">for_value</a><a href="#method.from_size_align">from_size_align</a><a href="#method.from_size_align_unchecked">from_size_align_unchecked</a><a href="#method.new">new</a><a href="#method.pad_to_align">pad_to_align</a><a href="#method.padding_needed_for">padding_needed_for</a><a href="#method.repeat">repeat</a><a href="#method.repeat_packed">repeat_packed</a><a href="#method.size">size</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Copy">Copy</a><a href="#impl-Debug">Debug</a><a href="#impl-Eq">Eq</a><a href="#impl-PartialEq%3CLayout%3E">PartialEq&lt;Layout&gt;</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow">Borrow</a><a href="#impl-BorrowMut">BorrowMut</a><a href="#impl-From">From</a><a href="#impl-Into">Into</a><a href="#impl-TryFrom">TryFrom</a><a href="#impl-TryInto">TryInto</a></div></div><p class='location'><a href='../index.html'>core</a>::<wbr><a href='index.html'>alloc</a></p><script>window.sidebarCurrent = {name: 'Layout', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush1.35.0.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme1.35.0.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel1.35.0.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='out-of-band'><span class='since' title='Stable since Rust version 1.28.0'>1.28.0</span><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/core/alloc.rs.html#38-50' title='goto source code'>[src]</a></span><span class='in-band'>Struct <a href='../index.html'>core</a>::<wbr><a href='index.html'>alloc</a>::<wbr><a class="struct" href=''>Layout</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust struct'><div class="docblock attributes">#[lang = "alloc_layout"]
</div>pub struct Layout { /* fields omitted */ }</pre></div><div class='docblock'><p>Layout of a block of memory.</p>
<p>An instance of <code>Layout</code> describes a particular layout of memory.
You build a <code>Layout</code> up as an input to give to an allocator.</p>
<p>All layouts have an associated non-negative size and a
power-of-two alignment.</p>
<p>(Note however that layouts are <em>not</em> required to have positive
size, even though many allocators require that all memory
requests have positive size. A caller to the <code>Alloc::alloc</code>
method must either ensure that conditions like this are met, or
use specific allocators with looser requirements.)</p>
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><code class='in-band'>impl <a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a></code><a href='#impl' class='anchor'></a><a class='srclink' href='../../src/core/alloc.rs.html#52-327' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_size_align' class="method"><code id='from_size_align.v'>pub fn <a href='#method.from_size_align' class='fnname'>from_size_align</a>(size: usize, align: usize) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="struct" href="../../core/alloc/struct.LayoutErr.html" title="struct core::alloc::LayoutErr">LayoutErr</a>&gt;</code><a class='srclink' href='../../src/core/alloc.rs.html#66-92' title='goto source code'>[src]</a></h4><div class='docblock'><p>Constructs a <code>Layout</code> from a given <code>size</code> and <code>align</code>,
or returns <code>LayoutErr</code> if either of the following conditions
are not met:</p>
<ul>
<li>
<p><code>align</code> must not be zero,</p>
</li>
<li>
<p><code>align</code> must be a power of two,</p>
</li>
<li>
<p><code>size</code>, when rounded up to the nearest multiple of <code>align</code>,
must not overflow (i.e., the rounded value must be less than
<code>usize::MAX</code>).</p>
</li>
</ul>
</div><h4 id='method.from_size_align_unchecked' class="method"><code id='from_size_align_unchecked.v'>pub unsafe fn <a href='#method.from_size_align_unchecked' class='fnname'>from_size_align_unchecked</a>(size: usize, align: usize) -&gt; Self</code><a class='srclink' href='../../src/core/alloc.rs.html#102-104' title='goto source code'>[src]</a></h4><div class='docblock'><p>Creates a layout, bypassing all checks.</p>
<h1 id="safety" class="section-header"><a href="#safety">Safety</a></h1>
<p>This function is unsafe as it does not verify the preconditions from
<a href="#method.from_size_align"><code>Layout::from_size_align</code></a>.</p>
</div><h4 id='method.size' class="method"><code id='size.v'>pub fn <a href='#method.size' class='fnname'>size</a>(&amp;self) -&gt; usize</code><a class='srclink' href='../../src/core/alloc.rs.html#109' title='goto source code'>[src]</a></h4><div class='docblock'><p>The minimum size in bytes for a memory block of this layout.</p>
</div><h4 id='method.align' class="method"><code id='align.v'>pub fn <a href='#method.align' class='fnname'>align</a>(&amp;self) -&gt; usize</code><a class='srclink' href='../../src/core/alloc.rs.html#114' title='goto source code'>[src]</a></h4><div class='docblock'><p>The minimum byte alignment for a memory block of this layout.</p>
</div><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>&lt;T&gt;() -&gt; Self</code><a class='srclink' href='../../src/core/alloc.rs.html#119-129' title='goto source code'>[src]</a></h4><div class='docblock'><p>Constructs a <code>Layout</code> suitable for holding a value of type <code>T</code>.</p>
</div><h4 id='method.for_value' class="method"><code id='for_value.v'>pub fn <a href='#method.for_value' class='fnname'>for_value</a>&lt;T:&nbsp;?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>&gt;(t: &amp;T) -&gt; Self</code><a class='srclink' href='../../src/core/alloc.rs.html#136-143' title='goto source code'>[src]</a></h4><div class='docblock'><p>Produces layout describing a record that could be used to
allocate backing structure for <code>T</code> (which could be a trait
or other unsized type like a slice).</p>
</div><h4 id='method.align_to' class="method"><code id='align_to.v'>pub fn <a href='#method.align_to' class='fnname'>align_to</a>(&amp;self, align: usize) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="struct" href="../../core/alloc/struct.LayoutErr.html" title="struct core::alloc::LayoutErr">LayoutErr</a>&gt;</code><a class='srclink' href='../../src/core/alloc.rs.html#162-164' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>alloc_layout_extra</code>&nbsp;<a href="https://github.com/rust-lang/rust/issues/55724">#55724</a>)</div></div><div class='docblock'><p>Creates a layout describing the record that can hold a value
of the same layout as <code>self</code>, but that also is aligned to
alignment <code>align</code> (measured in bytes).</p>
<p>If <code>self</code> already meets the prescribed alignment, then returns
<code>self</code>.</p>
<p>Note that this method does not add any padding to the overall
size, regardless of whether the returned layout has a different
alignment. In other words, if <code>K</code> has size 16, <code>K.align_to(32)</code>
will <em>still</em> have size 16.</p>
<p>Returns an error if the combination of <code>self.size()</code> and the given
<code>align</code> violates the conditions listed in
<a href="#method.from_size_align"><code>Layout::from_size_align</code></a>.</p>
</div><h4 id='method.padding_needed_for' class="method"><code id='padding_needed_for.v'>pub fn <a href='#method.padding_needed_for' class='fnname'>padding_needed_for</a>(&amp;self, align: usize) -&gt; usize</code><a class='srclink' href='../../src/core/alloc.rs.html#184-209' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>alloc_layout_extra</code>&nbsp;<a href="https://github.com/rust-lang/rust/issues/55724">#55724</a>)</div></div><div class='docblock'><p>Returns the amount of padding we must insert after <code>self</code>
to ensure that the following address will satisfy <code>align</code>
(measured in bytes).</p>
<p>e.g., if <code>self.size()</code> is 9, then <code>self.padding_needed_for(4)</code>
returns 3, because that is the minimum number of bytes of
padding required to get a 4-aligned address (assuming that the
corresponding memory block starts at a 4-aligned address).</p>
<p>The return value of this function has no meaning if <code>align</code> is
not a power-of-two.</p>
<p>Note that the utility of the returned value requires <code>align</code>
to be less than or equal to the alignment of the starting
address for the whole allocated block of memory. One way to
satisfy this constraint is to ensure <code>align &lt;= self.align()</code>.</p>
</div><h4 id='method.pad_to_align' class="method"><code id='pad_to_align.v'>pub fn <a href='#method.pad_to_align' class='fnname'>pad_to_align</a>(&amp;self) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a>, <a class="struct" href="../../core/alloc/struct.LayoutErr.html" title="struct core::alloc::LayoutErr">LayoutErr</a>&gt;</code><a class='srclink' href='../../src/core/alloc.rs.html#220-226' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>alloc_layout_extra</code>&nbsp;<a href="https://github.com/rust-lang/rust/issues/55724">#55724</a>)</div></div><div class='docblock'><p>Creates a layout by rounding the size of this layout up to a multiple
of the layout's alignment.</p>
<p>Returns <code>Err</code> if the padded size would overflow.</p>
<p>This is equivalent to adding the result of <code>padding_needed_for</code>
to the layout's current size.</p>
</div><h4 id='method.repeat' class="method"><code id='repeat.v'>pub fn <a href='#method.repeat' class='fnname'>repeat</a>(&amp;self, n: usize) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(Self, usize), <a class="struct" href="../../core/alloc/struct.LayoutErr.html" title="struct core::alloc::LayoutErr">LayoutErr</a>&gt;</code><a class='srclink' href='../../src/core/alloc.rs.html#238-249' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>alloc_layout_extra</code>&nbsp;<a href="https://github.com/rust-lang/rust/issues/55724">#55724</a>)</div></div><div class='docblock'><p>Creates a layout describing the record for <code>n</code> instances of
<code>self</code>, with a suitable amount of padding between each to
ensure that each instance is given its requested size and
alignment. On success, returns <code>(k, offs)</code> where <code>k</code> is the
layout of the array and <code>offs</code> is the distance between the start
of each element in the array.</p>
<p>On arithmetic overflow, returns <code>LayoutErr</code>.</p>
</div><h4 id='method.extend' class="method"><code id='extend.v'>pub fn <a href='#method.extend' class='fnname'>extend</a>(&amp;self, next: Self) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;(Self, usize), <a class="struct" href="../../core/alloc/struct.LayoutErr.html" title="struct core::alloc::LayoutErr">LayoutErr</a>&gt;</code><a class='srclink' href='../../src/core/alloc.rs.html#267-278' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>alloc_layout_extra</code>&nbsp;<a href="https://github.com/rust-lang/rust/issues/55724">#55724</a>)</div></div><div class='docblock'><p>Creates a layout describing the record for <code>self</code> followed by
<code>next</code>, including any necessary padding to ensure that <code>next</code>
will be properly aligned. Note that the result layout will
satisfy the alignment properties of both <code>self</code> and <code>next</code>.</p>
<p>The resulting layout will be the same as that of a C struct containing
two fields with the layouts of <code>self</code> and <code>next</code>, in that order.</p>
<p>Returns <code>Some((k, offset))</code>, where <code>k</code> is layout of the concatenated
record and <code>offset</code> is the relative location, in bytes, of the
start of the <code>next</code> embedded within the concatenated record
(assuming that the record itself starts at offset 0).</p>
<p>On arithmetic overflow, returns <code>LayoutErr</code>.</p>
</div><h4 id='method.repeat_packed' class="method"><code id='repeat_packed.v'>pub fn <a href='#method.repeat_packed' class='fnname'>repeat_packed</a>(&amp;self, n: usize) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="struct" href="../../core/alloc/struct.LayoutErr.html" title="struct core::alloc::LayoutErr">LayoutErr</a>&gt;</code><a class='srclink' href='../../src/core/alloc.rs.html#294-297' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>alloc_layout_extra</code>&nbsp;<a href="https://github.com/rust-lang/rust/issues/55724">#55724</a>)</div></div><div class='docblock'><p>Creates a layout describing the record for <code>n</code> instances of
<code>self</code>, with no padding between each instance.</p>
<p>Note that, unlike <code>repeat</code>, <code>repeat_packed</code> does not guarantee
that the repeated instances of <code>self</code> will be properly
aligned, even if a given instance of <code>self</code> is properly
aligned. In other words, if the layout returned by
<code>repeat_packed</code> is used to allocate an array, it is not
guaranteed that all elements in the array will be properly
aligned.</p>
<p>On arithmetic overflow, returns <code>LayoutErr</code>.</p>
</div><h4 id='method.extend_packed' class="method"><code id='extend_packed.v'>pub fn <a href='#method.extend_packed' class='fnname'>extend_packed</a>(&amp;self, next: Self) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="struct" href="../../core/alloc/struct.LayoutErr.html" title="struct core::alloc::LayoutErr">LayoutErr</a>&gt;</code><a class='srclink' href='../../src/core/alloc.rs.html#307-312' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>alloc_layout_extra</code>&nbsp;<a href="https://github.com/rust-lang/rust/issues/55724">#55724</a>)</div></div><div class='docblock'><p>Creates a layout describing the record for <code>self</code> followed by
<code>next</code> with no additional padding between the two. Since no
padding is inserted, the alignment of <code>next</code> is irrelevant,
and is not incorporated <em>at all</em> into the resulting layout.</p>
<p>On arithmetic overflow, returns <code>LayoutErr</code>.</p>
</div><h4 id='method.array' class="method"><code id='array.v'>pub fn <a href='#method.array' class='fnname'>array</a>&lt;T&gt;(n: usize) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;Self, <a class="struct" href="../../core/alloc/struct.LayoutErr.html" title="struct core::alloc::LayoutErr">LayoutErr</a>&gt;</code><a class='srclink' href='../../src/core/alloc.rs.html#319-326' title='goto source code'>[src]</a></h4><div class='stability'><div class='stab unstable'><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>alloc_layout_extra</code>&nbsp;<a href="https://github.com/rust-lang/rust/issues/55724">#55724</a>)</div></div><div class='docblock'><p>Creates a layout describing the record for a <code>[T; n]</code>.</p>
<p>On arithmetic overflow, returns <code>LayoutErr</code>.</p>
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Copy' class='impl'><code class='in-band'>impl <a class="trait" href="../../core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a> for <a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a></code><a href='#impl-Copy' class='anchor'></a><a class='srclink' href='../../src/core/alloc.rs.html#36' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-PartialEq%3CLayout%3E' class='impl'><code class='in-band'>impl <a class="trait" href="../../core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a>&lt;<a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a>&gt; for <a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a></code><a href='#impl-PartialEq%3CLayout%3E' class='anchor'></a><a class='srclink' href='../../src/core/alloc.rs.html#36' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.eq' class="method hidden"><code id='eq.v'>fn <a href='../../core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, other: &amp;<a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a>) -&gt; bool</code><a class='srclink' href='../../src/core/alloc.rs.html#36' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used by <code>==</code>. <a href="../../core/cmp/trait.PartialEq.html#tymethod.eq">Read more</a></p>
</div><h4 id='method.ne' class="method hidden"><code id='ne.v'>fn <a href='../../core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: &amp;<a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a>) -&gt; bool</code><a class='srclink' href='../../src/core/alloc.rs.html#36' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>This method tests for <code>!=</code>.</p>
</div></div><h3 id='impl-Eq' class='impl'><code class='in-band'>impl <a class="trait" href="../../core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a></code><a href='#impl-Eq' class='anchor'></a><a class='srclink' href='../../src/core/alloc.rs.html#36' title='goto source code'>[src]</a></h3><div class='impl-items'></div><h3 id='impl-Clone' class='impl'><code class='in-band'>impl <a class="trait" href="../../core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../../src/core/alloc.rs.html#36' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='../../core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a></code><a class='srclink' href='../../src/core/alloc.rs.html#36' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="../../core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
</div><h4 id='method.clone_from' class="method"><code id='clone_from.v'>fn <a href='../../core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='../../src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock'><p>Performs copy-assignment from <code>source</code>. <a href="../../core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl <a class="trait" href="../../core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../../src/core/alloc.rs.html#36' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='../../core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="../../core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="../../core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../../src/core/alloc.rs.html#36' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="../../core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><code class='in-band'>impl <a class="trait" href="../../core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl <a class="trait" href="../../core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../../core/alloc/struct.Layout.html" title="struct core::alloc::Layout">Layout</a></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-Into' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="../../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="../../core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-Into' class='anchor'></a><a class='srclink' href='../../src/core/convert.rs.html#537-542' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='../../core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(Self) -&gt; U</code><a class='srclink' href='../../src/core/convert.rs.html#539-541' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-From' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="../../core/convert/trait.From.html" title="trait core::convert::From">From</a> for T</code><a href='#impl-From' class='anchor'></a><a class='srclink' href='../../src/core/convert.rs.html#546-548' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from' class="method hidden"><code id='from.v'>fn <a href='../../core/convert/trait.From.html#tymethod.from' class='fnname'>from</a>(T) -&gt; T</code><a class='srclink' href='../../src/core/convert.rs.html#547' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryInto' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="../../core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="../../core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryInto' class='anchor'></a><a class='srclink' href='../../src/core/convert.rs.html#553-560' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='../../core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = &lt;U as <a class="trait" href="../../core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="../../core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='../../core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(Self) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="../../core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="type" href="../../core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='../../src/core/convert.rs.html#557-559' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-TryFrom' class='impl'><code class='in-band'>impl&lt;T, U&gt; <a class="trait" href="../../core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;U: <a class="trait" href="../../core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,&nbsp;</span></code><a href='#impl-TryFrom' class='anchor'></a><a class='srclink' href='../../src/core/convert.rs.html#565-571' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='../../core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="../../core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='../../core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(U) -&gt; <a class="enum" href="../../core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="../../core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="type" href="../../core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</code><a class='srclink' href='../../src/core/convert.rs.html#568-570' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
</div></div><h3 id='impl-Borrow' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="../../core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Borrow' class='anchor'></a><a class='srclink' href='../../src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='../../core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&amp;Self) -&gt; &amp;T</code><a class='srclink' href='../../src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="../../core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
</div></div><h3 id='impl-BorrowMut' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="../../core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-BorrowMut' class='anchor'></a><a class='srclink' href='../../src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='../../core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&amp;mut Self) -&gt; &amp;mut T</code><a class='srclink' href='../../src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="../../core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl&lt;T&gt; <a class="trait" href="../../core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;T: 'static + ?<a class="trait" href="../../core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='../../src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='../../core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&amp;Self) -&gt; <a class="struct" href="../../core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='../../src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="../../core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
</div></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "core";</script><script src="../../aliases.js"></script><script src="../../main1.35.0.js"></script><script defer src="../../search-index.js"></script></body></html>