mirror of
https://github.com/fluencelabs/wasmer
synced 2025-05-18 05:11:18 +00:00
299 lines
85 KiB
HTML
299 lines
85 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="API documentation for the Rust `Arena` struct in crate `generational_arena`."><meta name="keywords" content="rust, rustlang, rust-lang, Arena"><title>generational_arena::Arena - Rust</title><link rel="stylesheet" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../generational_arena/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Struct Arena</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.capacity">capacity</a><a href="#method.clear">clear</a><a href="#method.contains">contains</a><a href="#method.drain">drain</a><a href="#method.get">get</a><a href="#method.get2_mut">get2_mut</a><a href="#method.get_mut">get_mut</a><a href="#method.insert">insert</a><a href="#method.is_empty">is_empty</a><a href="#method.iter">iter</a><a href="#method.iter_mut">iter_mut</a><a href="#method.len">len</a><a href="#method.new">new</a><a href="#method.remove">remove</a><a href="#method.reserve">reserve</a><a href="#method.retain">retain</a><a href="#method.try_insert">try_insert</a><a href="#method.with_capacity">with_capacity</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Debug">Debug</a><a href="#impl-Deserialize%3C%27de%3E">Deserialize<'de></a><a href="#impl-Extend%3CT%3E">Extend<T></a><a href="#impl-FromIterator%3CT%3E">FromIterator<T></a><a href="#impl-Index%3CIndex%3E">Index<Index></a><a href="#impl-IndexMut%3CIndex%3E">IndexMut<Index></a><a href="#impl-IntoIterator">IntoIterator</a><a href="#impl-Serialize">Serialize</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-RefUnwindSafe">RefUnwindSafe</a><a href="#impl-Send">Send</a><a href="#impl-Sync">Sync</a><a href="#impl-Unpin">Unpin</a><a href="#impl-UnwindSafe">UnwindSafe</a></div><a class="sidebar-title" href="#blanket-implementations">Blanket Implementations</a><div class="sidebar-links"><a href="#impl-Any">Any</a><a href="#impl-Borrow%3CT%3E">Borrow<T></a><a href="#impl-BorrowMut%3CT%3E">BorrowMut<T></a><a href="#impl-DeserializeOwned">DeserializeOwned</a><a href="#impl-From%3CT%3E">From<T></a><a href="#impl-Into%3CU%3E">Into<U></a><a href="#impl-IntoIterator">IntoIterator</a><a href="#impl-ToOwned">ToOwned</a><a href="#impl-TryFrom%3CU%3E">TryFrom<U></a><a href="#impl-TryInto%3CU%3E">TryInto<U></a></div></div><p class='location'><a href='index.html'>generational_arena</a></p><script>window.sidebarCurrent = {name: 'Arena', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</op
|
||
|
|
<code>Index</code>.</p>
|
||
|
|
<p><a href="./index.html">See the module-level documentation for example usage and motivation.</a></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<T> <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#212-797' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.new' class="method"><code id='new.v'>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a class='srclink' href='../src/generational_arena/lib.rs.html#223-225' title='goto source code'>[src]</a></h4><div class='docblock'><p>Constructs a new, empty <code>Arena</code>.</p>
|
||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="op"><</span><span class="ident">usize</span><span class="op">></span>::<span class="ident">new</span>();</pre></div>
|
||
|
|
</div><h4 id='method.with_capacity' class="method"><code id='with_capacity.v'>pub fn <a href='#method.with_capacity' class='fnname'>with_capacity</a>(n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a class='srclink' href='../src/generational_arena/lib.rs.html#246-256' title='goto source code'>[src]</a></h4><div class='docblock'><p>Constructs a new, empty <code>Arena<T></code> with the specified capacity.</p>
|
||
|
|
<p>The <code>Arena<T></code> will be able to hold <code>n</code> elements without further allocation.</p>
|
||
|
|
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">with_capacity</span>(<span class="number">10</span>);
|
||
|
|
|
||
|
|
<span class="comment">// These insertions will not require further allocation.</span>
|
||
|
|
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">10</span> {
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">try_insert</span>(<span class="ident">i</span>).<span class="ident">is_ok</span>());
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="comment">// But now we are at capacity, and there is no more room.</span>
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">try_insert</span>(<span class="number">99</span>).<span class="ident">is_err</span>());</pre></div>
|
||
|
|
</div><h4 id='method.clear' class="method"><code id='clear.v'>pub fn <a href='#method.clear' class='fnname'>clear</a>(&mut self)</code><a class='srclink' href='../src/generational_arena/lib.rs.html#273-288' title='goto source code'>[src]</a></h4><div class='docblock'><p>Clear all the items inside the arena, but keep its allocation.</p>
|
||
|
|
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">with_capacity</span>(<span class="number">1</span>);
|
||
|
|
<span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">42</span>);
|
||
|
|
<span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">43</span>);
|
||
|
|
|
||
|
|
<span class="ident">arena</span>.<span class="ident">clear</span>();
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">capacity</span>(), <span class="number">2</span>);</pre></div>
|
||
|
|
</div><h4 id='method.try_insert' class="method"><code id='try_insert.v'>pub fn <a href='#method.try_insert' class='fnname'>try_insert</a>(&mut self, value: T) -> <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="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>, T></code><a class='srclink' href='../src/generational_arena/lib.rs.html#317-336' title='goto source code'>[src]</a></h4><div class='docblock'><p>Attempts to insert <code>value</code> into the arena using existing capacity.</p>
|
||
|
|
<p>This method will never allocate new capacity in the arena.</p>
|
||
|
|
<p>If insertion succeeds, then the <code>value</code>'s index is returned. If
|
||
|
|
insertion fails, then <code>Err(value)</code> is returned to give ownership of
|
||
|
|
<code>value</code> back to the caller.</p>
|
||
|
|
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
|
||
|
|
<span class="kw">match</span> <span class="ident">arena</span>.<span class="ident">try_insert</span>(<span class="number">42</span>) {
|
||
|
|
<span class="prelude-val">Ok</span>(<span class="ident">idx</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="comment">// Insertion succeeded.</span>
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>[<span class="ident">idx</span>], <span class="number">42</span>);
|
||
|
|
}
|
||
|
|
<span class="prelude-val">Err</span>(<span class="ident">x</span>) <span class="op">=</span><span class="op">></span> {
|
||
|
|
<span class="comment">// Insertion failed.</span>
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">x</span>, <span class="number">42</span>);
|
||
|
|
}
|
||
|
|
};</pre></div>
|
||
|
|
</div><h4 id='method.insert' class="method"><code id='insert.v'>pub fn <a href='#method.insert' class='fnname'>insert</a>(&mut self, value: T) -> <a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#353-358' title='goto source code'>[src]</a></h4><div class='docblock'><p>Insert <code>value</code> into the arena, allocating more capacity if necessary.</p>
|
||
|
|
<p>The <code>value</code>'s associated index in the arena is returned.</p>
|
||
|
|
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">42</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>[<span class="ident">idx</span>], <span class="number">42</span>);</pre></div>
|
||
|
|
</div><h4 id='method.remove' class="method"><code id='remove.v'>pub fn <a href='#method.remove' class='fnname'>remove</a>(&mut self, i: <a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><T></code><a class='srclink' href='../src/generational_arena/lib.rs.html#385-413' title='goto source code'>[src]</a></h4><div class='docblock'><p>Remove the element at index <code>i</code> from the arena.</p>
|
||
|
|
<p>If the element at index <code>i</code> is still in the arena, then it is
|
||
|
|
returned. If it is not in the arena, then <code>None</code> is returned.</p>
|
||
|
|
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">42</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">remove</span>(<span class="ident">idx</span>), <span class="prelude-val">Some</span>(<span class="number">42</span>));
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">remove</span>(<span class="ident">idx</span>), <span class="prelude-val">None</span>);</pre></div>
|
||
|
|
</div><h4 id='method.retain' class="method"><code id='retain.v'>pub fn <a href='#method.retain' class='fnname'>retain</a>(&mut self, predicate: impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>)</code><a class='srclink' href='../src/generational_arena/lib.rs.html#433-454' title='goto source code'>[src]</a></h4><div class='docblock'><p>Retains only the elements specified by the predicate.</p>
|
||
|
|
<p>In other words, remove all indices such that <code>predicate(index, &value)</code> returns <code>false</code>.</p>
|
||
|
|
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">crew</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="ident">crew</span>.<span class="ident">extend</span>(<span class="kw-2">&</span>[<span class="string">"Jim Hawkins"</span>, <span class="string">"John Silver"</span>, <span class="string">"Alexander Smollett"</span>, <span class="string">"Israel Hands"</span>]);
|
||
|
|
<span class="kw">let</span> <span class="ident">pirates</span> <span class="op">=</span> [<span class="string">"John Silver"</span>, <span class="string">"Israel Hands"</span>]; <span class="comment">// too dangerous to keep them around</span>
|
||
|
|
<span class="ident">crew</span>.<span class="ident">retain</span>(<span class="op">|</span><span class="ident">_index</span>, <span class="ident">member</span><span class="op">|</span> <span class="op">!</span><span class="ident">pirates</span>.<span class="ident">contains</span>(<span class="ident">member</span>));
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">crew_members</span> <span class="op">=</span> <span class="ident">crew</span>.<span class="ident">iter</span>().<span class="ident">map</span>(<span class="op">|</span>(<span class="kw">_</span>, <span class="ident">member</span>)<span class="op">|</span> <span class="kw-2">*</span><span class="kw-2">*</span><span class="ident">member</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">crew_members</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="string">"Jim Hawkins"</span>));
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">crew_members</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>(<span class="string">"Alexander Smollett"</span>));
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">crew_members</span>.<span class="ident">next</span>().<span class="ident">is_none</span>());</pre></div>
|
||
|
|
</div><h4 id='method.contains' class="method"><code id='contains.v'>pub fn <a href='#method.contains' class='fnname'>contains</a>(&self, i: <a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#472-474' title='goto source code'>[src]</a></h4><div class='docblock'><p>Is the element at index <code>i</code> in the arena?</p>
|
||
|
|
<p>Returns <code>true</code> if the element at <code>i</code> is in the arena, <code>false</code> otherwise.</p>
|
||
|
|
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">42</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">contains</span>(<span class="ident">idx</span>));
|
||
|
|
<span class="ident">arena</span>.<span class="ident">remove</span>(<span class="ident">idx</span>);
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">arena</span>.<span class="ident">contains</span>(<span class="ident">idx</span>));</pre></div>
|
||
|
|
</div><h4 id='method.get' class="method"><code id='get.v'>pub fn <a href='#method.get' class='fnname'>get</a>(&self, i: <a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</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></code><a class='srclink' href='../src/generational_arena/lib.rs.html#493-501' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get a shared reference to the element at index <code>i</code> if it is in the
|
||
|
|
arena.</p>
|
||
|
|
<p>If the element at index <code>i</code> is not in the arena, then <code>None</code> is returned.</p>
|
||
|
|
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">42</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">get</span>(<span class="ident">idx</span>), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">42</span>));
|
||
|
|
<span class="ident">arena</span>.<span class="ident">remove</span>(<span class="ident">idx</span>);
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">get</span>(<span class="ident">idx</span>).<span class="ident">is_none</span>());</pre></div>
|
||
|
|
</div><h4 id='method.get_mut' class="method"><code id='get_mut.v'>pub fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&mut self, i: <a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</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></code><a class='srclink' href='../src/generational_arena/lib.rs.html#520-528' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get an exclusive reference to the element at index <code>i</code> if it is in the
|
||
|
|
arena.</p>
|
||
|
|
<p>If the element at index <code>i</code> is not in the arena, then <code>None</code> is returned.</p>
|
||
|
|
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">42</span>);
|
||
|
|
|
||
|
|
<span class="kw-2">*</span><span class="ident">arena</span>.<span class="ident">get_mut</span>(<span class="ident">idx</span>).<span class="ident">unwrap</span>() <span class="op">+</span><span class="op">=</span> <span class="number">1</span>;
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">remove</span>(<span class="ident">idx</span>), <span class="prelude-val">Some</span>(<span class="number">43</span>));
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">get_mut</span>(<span class="ident">idx</span>).<span class="ident">is_none</span>());</pre></div>
|
||
|
|
</div><h4 id='method.get2_mut' class="method"><code id='get2_mut.v'>pub fn <a href='#method.get2_mut' class='fnname'>get2_mut</a>(<br> &mut self, <br> i1: <a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>, <br> i2: <a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a><br>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</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>, <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><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#559-603' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get a pair of exclusive references to the elements at index <code>i1</code> and <code>i2</code> if it is in the
|
||
|
|
arena.</p>
|
||
|
|
<p>If the element at index <code>i1</code> or <code>i2</code> is not in the arena, then <code>None</code> is returned for this
|
||
|
|
element.</p>
|
||
|
|
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
|
|
<p>Panics if <code>i1</code> and <code>i2</code> are pointing to the same item of the arena.</p>
|
||
|
|
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">idx1</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">0</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">idx2</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">1</span>);
|
||
|
|
|
||
|
|
{
|
||
|
|
<span class="kw">let</span> (<span class="ident">item1</span>, <span class="ident">item2</span>) <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">get2_mut</span>(<span class="ident">idx1</span>, <span class="ident">idx2</span>);
|
||
|
|
|
||
|
|
<span class="kw-2">*</span><span class="ident">item1</span>.<span class="ident">unwrap</span>() <span class="op">=</span> <span class="number">3</span>;
|
||
|
|
<span class="kw-2">*</span><span class="ident">item2</span>.<span class="ident">unwrap</span>() <span class="op">=</span> <span class="number">4</span>;
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>[<span class="ident">idx1</span>], <span class="number">3</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>[<span class="ident">idx2</span>], <span class="number">4</span>);</pre></div>
|
||
|
|
</div><h4 id='method.len' class="method"><code id='len.v'>pub fn <a href='#method.len' class='fnname'>len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#626-628' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the length of this arena.</p>
|
||
|
|
<p>The length is the number of elements the arena holds.</p>
|
||
|
|
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">len</span>(), <span class="number">0</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">42</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">len</span>(), <span class="number">1</span>);
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw">_</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">0</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">len</span>(), <span class="number">2</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">remove</span>(<span class="ident">idx</span>), <span class="prelude-val">Some</span>(<span class="number">42</span>));
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">len</span>(), <span class="number">1</span>);</pre></div>
|
||
|
|
</div><h4 id='method.is_empty' class="method"><code id='is_empty.v'>pub fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#646-648' title='goto source code'>[src]</a></h4><div class='docblock'><p>Returns true if the arena contains no elements</p>
|
||
|
|
<h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">is_empty</span>());
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">42</span>);
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">arena</span>.<span class="ident">is_empty</span>());
|
||
|
|
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">remove</span>(<span class="ident">idx</span>), <span class="prelude-val">Some</span>(<span class="number">42</span>));
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">is_empty</span>());</pre></div>
|
||
|
|
</div><h4 id='method.capacity' class="method"><code id='capacity.v'>pub fn <a href='#method.capacity' class='fnname'>capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#674-676' title='goto source code'>[src]</a></h4><div class='docblock'><p>Get the capacity of this arena.</p>
|
||
|
|
<p>The capacity is the maximum number of elements the arena can hold
|
||
|
|
without further allocation, including however many it currently
|
||
|
|
contains.</p>
|
||
|
|
<h1 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">with_capacity</span>(<span class="number">10</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">capacity</span>(), <span class="number">10</span>);
|
||
|
|
|
||
|
|
<span class="comment">// `try_insert` does not allocate new capacity.</span>
|
||
|
|
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">10</span> {
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">try_insert</span>(<span class="number">1</span>).<span class="ident">is_ok</span>());
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">capacity</span>(), <span class="number">10</span>);
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="comment">// But `insert` will if the arena is already at capacity.</span>
|
||
|
|
<span class="ident">arena</span>.<span class="ident">insert</span>(<span class="number">0</span>);
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">capacity</span>() <span class="op">></span> <span class="number">10</span>);</pre></div>
|
||
|
|
</div><h4 id='method.reserve' class="method"><code id='reserve.v'>pub fn <a href='#method.reserve' class='fnname'>reserve</a>(&mut self, additional_capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code><a class='srclink' href='../src/generational_arena/lib.rs.html#694-711' title='goto source code'>[src]</a></h4><div class='docblock'><p>Allocate space for <code>additional_capacity</code> more elements in the arena.</p>
|
||
|
|
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
||
|
|
<p>Panics if this causes the capacity to overflow.</p>
|
||
|
|
<h1 id="examples-14" class="section-header"><a href="#examples-14">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">with_capacity</span>(<span class="number">10</span>);
|
||
|
|
<span class="ident">arena</span>.<span class="ident">reserve</span>(<span class="number">5</span>);
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">capacity</span>(), <span class="number">15</span>);</pre></div>
|
||
|
|
</div><h4 id='method.iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../generational_arena/struct.Iter.html" title="struct generational_arena::Iter">Iter</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../generational_arena/struct.Iter.html" title="struct generational_arena::Iter">Iter</a><'a, T></h3><code class="content"><span class="where fmt-newline">impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../generational_arena/struct.Iter.html" title="struct generational_arena::Iter">Iter</a><'a, T></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></div></div><code id='iter.v'>pub fn <a href='#method.iter' class='fnname'>iter</a>(&self) -> <a class="struct" href="../generational_arena/struct.Iter.html" title="struct generational_arena::Iter">Iter</a><T></code><a class='srclink' href='../src/generational_arena/lib.rs.html#733-738' title='goto source code'>[src]</a></h4><div class='docblock'><p>Iterate over shared references to the elements in this arena.</p>
|
||
|
|
<p>Yields pairs of <code>(Index, &T)</code> items.</p>
|
||
|
|
<p>Order of iteration is not defined.</p>
|
||
|
|
<h1 id="examples-15" class="section-header"><a href="#examples-15">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">10</span> {
|
||
|
|
<span class="ident">arena</span>.<span class="ident">insert</span>(<span class="ident">i</span> <span class="op">*</span> <span class="ident">i</span>);
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="kw">for</span> (<span class="ident">idx</span>, <span class="ident">value</span>) <span class="kw">in</span> <span class="ident">arena</span>.<span class="ident">iter</span>() {
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{} is at index {:?}"</span>, <span class="ident">value</span>, <span class="ident">idx</span>);
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id='method.iter_mut' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../generational_arena/struct.IterMut.html" title="struct generational_arena::IterMut">IterMut</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../generational_arena/struct.IterMut.html" title="struct generational_arena::IterMut">IterMut</a><'a, T></h3><code class="content"><span class="where fmt-newline">impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../generational_arena/struct.IterMut.html" title="struct generational_arena::IterMut">IterMut</a><'a, T></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></div></div><code id='iter_mut.v'>pub fn <a href='#method.iter_mut' class='fnname'>iter_mut</a>(&mut self) -> <a class="struct" href="../generational_arena/struct.IterMut.html" title="struct generational_arena::IterMut">IterMut</a><T></code><a class='srclink' href='../src/generational_arena/lib.rs.html#760-765' title='goto source code'>[src]</a></h4><div class='docblock'><p>Iterate over exclusive references to the elements in this arena.</p>
|
||
|
|
<p>Yields pairs of <code>(Index, &mut T)</code> items.</p>
|
||
|
|
<p>Order of iteration is not defined.</p>
|
||
|
|
<h1 id="examples-16" class="section-header"><a href="#examples-16">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">10</span> {
|
||
|
|
<span class="ident">arena</span>.<span class="ident">insert</span>(<span class="ident">i</span> <span class="op">*</span> <span class="ident">i</span>);
|
||
|
|
}
|
||
|
|
|
||
|
|
<span class="kw">for</span> (<span class="ident">_idx</span>, <span class="ident">value</span>) <span class="kw">in</span> <span class="ident">arena</span>.<span class="ident">iter_mut</span>() {
|
||
|
|
<span class="kw-2">*</span><span class="ident">value</span> <span class="op">+</span><span class="op">=</span> <span class="number">5</span>;
|
||
|
|
}</pre></div>
|
||
|
|
</div><h4 id='method.drain' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../generational_arena/struct.Drain.html" title="struct generational_arena::Drain">Drain</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../generational_arena/struct.Drain.html" title="struct generational_arena::Drain">Drain</a><'a, T></h3><code class="content"><span class="where fmt-newline">impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> for <a class="struct" href="../generational_arena/struct.Drain.html" title="struct generational_arena::Drain">Drain</a><'a, T></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>, T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></div></div><code id='drain.v'>pub fn <a href='#method.drain' class='fnname'>drain</a>(&mut self) -> <a class="struct" href="../generational_arena/struct.Drain.html" title="struct generational_arena::Drain">Drain</a><T></code><a class='srclink' href='../src/generational_arena/lib.rs.html#792-796' title='goto source code'>[src]</a></h4><div class='docblock'><p>Iterate over elements of the arena and remove them.</p>
|
||
|
|
<p>Yields pairs of <code>(Index, T)</code> items.</p>
|
||
|
|
<p>Order of iteration is not defined.</p>
|
||
|
|
<p>Note: All elements are removed even if the iterator is only partially consumed or not consumed at all.</p>
|
||
|
|
<h1 id="examples-17" class="section-header"><a href="#examples-17">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">generational_arena</span>::<span class="ident">Arena</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">arena</span> <span class="op">=</span> <span class="ident">Arena</span>::<span class="ident">new</span>();
|
||
|
|
<span class="kw">let</span> <span class="ident">idx_1</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="string">"hello"</span>);
|
||
|
|
<span class="kw">let</span> <span class="ident">idx_2</span> <span class="op">=</span> <span class="ident">arena</span>.<span class="ident">insert</span>(<span class="string">"world"</span>);
|
||
|
|
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">get</span>(<span class="ident">idx_1</span>).<span class="ident">is_some</span>());
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">get</span>(<span class="ident">idx_2</span>).<span class="ident">is_some</span>());
|
||
|
|
<span class="kw">for</span> (<span class="ident">idx</span>, <span class="ident">value</span>) <span class="kw">in</span> <span class="ident">arena</span>.<span class="ident">drain</span>() {
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>((<span class="ident">idx</span> <span class="op">=</span><span class="op">=</span> <span class="ident">idx_1</span> <span class="kw-2">&</span><span class="op">&</span> <span class="ident">value</span> <span class="op">=</span><span class="op">=</span> <span class="string">"hello"</span>) <span class="op">|</span><span class="op">|</span> (<span class="ident">idx</span> <span class="op">=</span><span class="op">=</span> <span class="ident">idx_2</span> <span class="kw-2">&</span><span class="op">&</span> <span class="ident">value</span> <span class="op">=</span><span class="op">=</span> <span class="string">"world"</span>));
|
||
|
|
}
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">get</span>(<span class="ident">idx_1</span>).<span class="ident">is_none</span>());
|
||
|
|
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">arena</span>.<span class="ident">get</span>(<span class="ident">idx_2</span>).<span class="ident">is_none</span>());</pre></div>
|
||
|
|
</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-Index%3CIndex%3E' class='impl'><code class='in-band'>impl<T> <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="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>> for <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl-Index%3CIndex%3E' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#1149-1155' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Output' class="type"><code id='Output.t'>type <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output' class="type">Output</a> = T</code></h4><div class='docblock'><p>The returned type after indexing.</p>
|
||
|
|
</div><h4 id='method.index' class="method hidden"><code id='index.v'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#tymethod.index' class='fnname'>index</a>(&self, index: <a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>) -> &Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#1152-1154' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the indexing (<code>container[index]</code>) operation.</p>
|
||
|
|
</div></div><h3 id='impl-IndexMut%3CIndex%3E' class='impl'><code class='in-band'>impl<T> <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="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>> for <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl-IndexMut%3CIndex%3E' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#1157-1161' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.index_mut' class="method hidden"><code id='index_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.IndexMut.html#tymethod.index_mut' class='fnname'>index_mut</a>(&mut self, index: <a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>) -> &mut Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output" title="type core::ops::index::Index::Output">Output</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#1158-1160' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the mutable indexing (<code>container[index]</code>) operation.</p>
|
||
|
|
</div></div><h3 id='impl-Debug' class='impl'><code class='in-band'>impl<T: <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="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl-Debug' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#176' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.fmt' class="method hidden"><code id='fmt.v'>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#176' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-FromIterator%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html" title="trait core::iter::traits::collect::FromIterator">FromIterator</a><T> for <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl-FromIterator%3CT%3E' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#1137-1147' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.from_iter' class="method hidden"><code id='from_iter.v'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html#tymethod.from_iter' class='fnname'>from_iter</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>>(iter: I) -> Self</code><a class='srclink' href='../src/generational_arena/lib.rs.html#1138-1146' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates a value from an iterator. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.FromIterator.html#tymethod.from_iter">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-IntoIterator' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl-IntoIterator' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#799-808' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item' class="type"><code id='Item.t'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = T</code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
|
|
</div><h4 id='associatedtype.IntoIter' class="type"><code id='IntoIter.t'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../generational_arena/struct.IntoIter.html" title="struct generational_arena::IntoIter">IntoIter</a><T></code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
|
|
</div><h4 id='method.into_iter' class="method hidden"><code id='into_iter.v'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#802-807' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-IntoIterator-1' class='impl'><code class='in-band'>impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl-IntoIterator-1' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#886-892' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-1' class="type"><code id='Item.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
|
|
</div><h4 id='associatedtype.IntoIter-1' class="type"><code id='IntoIter.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../generational_arena/struct.Iter.html" title="struct generational_arena::Iter">Iter</a><'a, T></code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
|
|
</div><h4 id='method.into_iter-1' class="method hidden"><code id='into_iter.v-1'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#889-891' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-IntoIterator-2' class='impl'><code class='in-band'>impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl-IntoIterator-2' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#984-990' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-2' class="type"><code id='Item.t-2'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a><a class="struct" href="../generational_arena/struct.Index.html" title="struct generational_arena::Index">Index</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
|
|
</div><h4 id='associatedtype.IntoIter-2' class="type"><code id='IntoIter.t-2'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../generational_arena/struct.IterMut.html" title="struct generational_arena::IterMut">IterMut</a><'a, T></code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
|
|
</div><h4 id='method.into_iter-2' class="method hidden"><code id='into_iter.v-2'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> Self::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></code><a class='srclink' href='../src/generational_arena/lib.rs.html#987-989' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Extend%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a><T> for <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl-Extend%3CT%3E' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#1129-1135' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.extend' class="method hidden"><code id='extend.v'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#tymethod.extend' class='fnname'>extend</a><I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = T>>(&mut self, iter: I)</code><a class='srclink' href='../src/generational_arena/lib.rs.html#1130-1134' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Extends a collection with the contents of an iterator. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.Extend.html#tymethod.extend">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Clone' class='impl'><code class='in-band'>impl<T: <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="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a href='#impl-Clone' class='anchor'></a><a class='srclink' href='../src/generational_arena/lib.rs.html#176' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.clone' class="method hidden"><code id='clone.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&self) -> <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T></code><a class='srclink' href='../src/generational_arena/lib.rs.html#176' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Returns a copy of the value. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone">Read more</a></p>
|
||
|
|
</div><h4 id='method.clone_from' class="method hidden"><code id='clone_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&mut self, source: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>Self)</code><span class='since' title='Stable since Rust version 1.0.0'>1.0.0</span><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#131-133' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Serialize' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a> for <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../serde/ser/trait.Serialize.html" title="trait serde::ser::Serialize">Serialize</a>, </span></code><a href='#impl-Serialize' class='anchor'></a><a class='srclink' href='../src/generational_arena/serde_impl.rs.html#30-45' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.serialize' class="method hidden"><code id='serialize.v'>fn <a href='../serde/ser/trait.Serialize.html#tymethod.serialize' class='fnname'>serialize</a><S>(&self, serializer: S) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Ok" title="type serde::ser::Serializer::Ok">Ok</a>, S::<a class="type" href="../serde/ser/trait.Serializer.html#associatedtype.Error" title="type serde::ser::Serializer::Error">Error</a>> <span class="where fmt-newline">where<br> S: <a class="trait" href="../serde/ser/trait.Serializer.html" title="trait serde::ser::Serializer">Serializer</a>, </span></code><a class='srclink' href='../src/generational_arena/serde_impl.rs.html#34-44' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Serialize this value into the given Serde serializer. <a href="../serde/ser/trait.Serialize.html#tymethod.serialize">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Deserialize%3C%27de%3E' class='impl'><code class='in-band'>impl<'de, T> <a class="trait" href="../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a><'de> for <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a><'de>, </span></code><a href='#impl-Deserialize%3C%27de%3E' class='anchor'></a><a class='srclink' href='../src/generational_arena/serde_impl.rs.html#47-57' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.deserialize' class="method hidden"><code id='deserialize.v'>fn <a href='../serde/de/trait.Deserialize.html#tymethod.deserialize' class='fnname'>deserialize</a><D>(deserializer: D) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><Self, D::<a class="type" href="../serde/de/trait.Deserializer.html#associatedtype.Error" title="type serde::de::Deserializer::Error">Error</a>> <span class="where fmt-newline">where<br> D: <a class="trait" href="../serde/de/trait.Deserializer.html" title="trait serde::de::Deserializer">Deserializer</a><'de>, </span></code><a class='srclink' href='../src/generational_arena/serde_impl.rs.html#51-56' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Deserialize this value from the given Serde deserializer. <a href="../serde/de/trait.Deserialize.html#tymethod.deserialize">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-Unpin' class='impl'><code class='in-band'>impl<T> <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="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>, </span></code><a href='#impl-Unpin' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Send' class='impl'><code class='in-band'>impl<T> <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="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-Send' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><code class='in-band'>impl<T> <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="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>, </span></code><a href='#impl-Sync' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-UnwindSafe' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a> for <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.UnwindSafe.html" title="trait std::panic::UnwindSafe">UnwindSafe</a>, </span></code><a href='#impl-UnwindSafe' class='anchor'></a></h3><div class='impl-items'></div><h3 id='impl-RefUnwindSafe' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="../generational_arena/struct.Arena.html" title="struct generational_arena::Arena">Arena</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/std/panic/trait.RefUnwindSafe.html" title="trait std::panic::RefUnwindSafe">RefUnwindSafe</a>, </span></code><a href='#impl-RefUnwindSafe' class='anchor'></a></h3><div class='impl-items'></div></div><h2 id='blanket-implementations' class='small-section-header'>Blanket Implementations<a href='#blanket-implementations' class='anchor'></a></h2><div id='blanket-implementations-list'><h3 id='impl-From%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</code><a href='#impl-From%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#552-554' 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='ht
|
||
|
|
</div></div><h3 id='impl-TryFrom%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>, </span></code><a href='#impl-TryFrom%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#571-577' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error' class="type"><code id='Error.t'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error' class="type">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
|
|
</div><h4 id='method.try_from' class="method hidden"><code id='try_from.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from' class='fnname'>try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#574-576' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-Into%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>, </span></code><a href='#impl-Into%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#543-548' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.into' class="method hidden"><code id='into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into' class='fnname'>into</a>(self) -> U</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#545-547' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-TryInto%3CU%3E' class='impl'><code class='in-band'>impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T <span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>, </span></code><a href='#impl-TryInto%3CU%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#559-566' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Error-1' class="type"><code id='Error.t-1'>type <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error' class="type">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></code></h4><div class='docblock'><p>The type returned in the event of a conversion error.</p>
|
||
|
|
</div><h4 id='method.try_into' class="method hidden"><code id='try_into.v'>fn <a href='https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into' class='fnname'>try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/convert.rs.html#563-565' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Performs the conversion.</p>
|
||
|
|
</div></div><h3 id='impl-IntoIterator-3' class='impl'><code class='in-band'>impl<I> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for I <span class="where fmt-newline">where<br> I: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>, </span></code><a href='#impl-IntoIterator-3' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/iter/traits/collect.rs.html#242-249' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-3' class="type"><code id='Item.t-3'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item' class="type">Item</a> = <I as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::traits::iterator::Iterator::Item">Item</a></code></h4><div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
|
|
</div><h4 id='associatedtype.IntoIter-3' class="type"><code id='IntoIter.t-3'>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = I</code></h4><div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
|
|
</div><h4 id='method.into_iter-3' class="method hidden"><code id='into_iter.v-3'>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> I</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/iter/traits/collect.rs.html#246-248' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Borrow%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Borrow%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213-215' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow' class="method hidden"><code id='borrow.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow' class='fnname'>borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#214' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-BorrowMut%3CT%3E' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T <span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-BorrowMut%3CT%3E' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#218-220' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.borrow_mut' class="method hidden"><code id='borrow_mut.v'>fn <a href='https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut' class='fnname'>borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#219' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-Any' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T <span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code><a href='#impl-Any' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#100-102' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.type_id' class="method hidden"><code id='type_id.v'>fn <a href='https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id' class='fnname'>type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/any.rs.html#101' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-ToOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, </span></code><a href='#impl-ToOwned' class='anchor'></a><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#81-92' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Owned' class="type"><code id='Owned.t'>type <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#associatedtype.Owned' class="type">Owned</a> = T</code></h4><div class='docblock'><p>The resulting type after obtaining ownership.</p>
|
||
|
|
</div><h4 id='method.to_owned' class="method hidden"><code id='to_owned.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned' class='fnname'>to_owned</a>(&self) -> T</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#85-87' title='goto source code'>[src]</a></h4><div class='docblock hidden'><p>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></p>
|
||
|
|
</div><h4 id='method.clone_into' class="method hidden"><code id='clone_into.v'>fn <a href='https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into' class='fnname'>clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T)</code><a class='srclink' href='https://doc.rust-lang.org/nightly/src/alloc/borrow.rs.html#89-91' title='goto source code'>[src]</a></h4><div class='stability hidden'><div class='stab unstable'><details><summary><span class='emoji'>🔬</span> This is a nightly-only experimental API. (<code>toowned_clone_into</code>)</summary><p>recently added</p>
|
||
|
|
</details></div></div><div class='docblock hidden'><p>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/nightly/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></p>
|
||
|
|
</div></div><h3 id='impl-DeserializeOwned' class='impl'><code class='in-band'>impl<T> <a class="trait" href="../serde/de/trait.DeserializeOwned.html" title="trait serde::de::DeserializeOwned">DeserializeOwned</a> for T <span class="where fmt-newline">where<br> T: <a class="trait" href="../serde/de/trait.Deserialize.html" title="trait serde::de::Deserialize">Deserialize</a><'de>, </span></code><a href='#impl-DeserializeOwned' class='anchor'></a><a class='srclink' href='../src/serde/de/mod.rs.html#597' title='goto source code'>[src]</a></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g., <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g., <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "generational_arena";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|