478 lines
No EOL
60 KiB
HTML
478 lines
No EOL
60 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 `Slab` struct in crate `slab`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, Slab">
|
||
|
||
<title>slab::Slab - 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="../main.css" id="themeStyle">
|
||
<script src="../storage.js"></script>
|
||
|
||
|
||
|
||
|
||
</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>
|
||
|
||
<p class='location'>Struct Slab</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a><a href="#method.with_capacity">with_capacity</a><a href="#method.capacity">capacity</a><a href="#method.reserve">reserve</a><a href="#method.reserve_exact">reserve_exact</a><a href="#method.shrink_to_fit">shrink_to_fit</a><a href="#method.clear">clear</a><a href="#method.len">len</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.get">get</a><a href="#method.get_mut">get_mut</a><a href="#method.get_unchecked">get_unchecked</a><a href="#method.get_unchecked_mut">get_unchecked_mut</a><a href="#method.insert">insert</a><a href="#method.vacant_entry">vacant_entry</a><a href="#method.remove">remove</a><a href="#method.contains">contains</a><a href="#method.retain">retain</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Clone">Clone</a><a href="#impl-Default">Default</a><a href="#impl-Index%3Cusize%3E">Index<usize></a><a href="#impl-IndexMut%3Cusize%3E">IndexMut<usize></a><a href="#impl-IntoIterator">IntoIterator</a><a href="#impl-Debug">Debug</a></div></div><p class='location'><a href='index.html'>slab</a></p><script>window.sidebarCurrent = {name: 'Slab', 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">
|
||
<input class="search-input" name="search"
|
||
autocomplete="off"
|
||
placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
|
||
type="search">
|
||
</div>
|
||
</form>
|
||
</nav>
|
||
|
||
<section id='main' class="content">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>slab</a>::<wbr><a class="struct" href=''>Slab</a></span><span class='out-of-band'><span id='render-detail'>
|
||
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
|
||
[<span class='inner'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../src/slab/lib.rs.html#115-125' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct Slab<T> { /* fields omitted */ }</pre><div class='docblock'><p>Pre-allocated storage for a uniform data type</p>
|
||
<p>See the <a href="index.html">module documentation</a> for more details.</p>
|
||
</div>
|
||
<h2 id='methods' class='small-section-header'>
|
||
Methods<a href='#methods' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl' class='impl'><span class='in-band'><code>impl<T> <a class="struct" href="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#179-748' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#191-193' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Construct a new, empty <code>Slab</code>.</p>
|
||
<p>The function does not allocate and the returned slab will have no
|
||
capacity until <code>insert</code> is called or capacity is explicitly reserved.</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">slab</span>: <span class="ident">Slab</span><span class="op"><</span><span class="ident">i32</span><span class="op">></span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();</pre>
|
||
</div><h4 id='method.with_capacity' class="method"><span id='with_capacity.v' class='invisible'><code>pub fn <a href='#method.with_capacity' class='fnname'>with_capacity</a>(capacity: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#222-228' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Construct a new, empty <code>Slab</code> with the specified capacity.</p>
|
||
<p>The returned slab will be able to store exactly <code>capacity</code> without
|
||
reallocating. If <code>capacity</code> is 0, the slab will not allocate.</p>
|
||
<p>It is important to note that this function does not specify the <em>length</em>
|
||
of the returned slab, but only the capacity. For an explanation of the
|
||
difference between length and capacity, see <a href="index.html#capacity-and-reallocation">Capacity and
|
||
reallocation</a>.</p>
|
||
<h1 id="examples-1" class="section-header"><a href="#examples-1">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">with_capacity</span>(<span class="number">10</span>);
|
||
|
||
<span class="comment">// The slab contains no values, even though it has capacity for more</span>
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">len</span>(), <span class="number">0</span>);
|
||
|
||
<span class="comment">// These are all done without reallocating...</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">slab</span>.<span class="ident">insert</span>(<span class="ident">i</span>);
|
||
}
|
||
|
||
<span class="comment">// ...but this may make the slab reallocate</span>
|
||
<span class="ident">slab</span>.<span class="ident">insert</span>(<span class="number">11</span>);</pre>
|
||
</div><h4 id='method.capacity' class="method"><span id='capacity.v' class='invisible'><code>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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#239-241' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return the number of values the slab can store without reallocating.</p>
|
||
<h1 id="examples-2" class="section-header"><a href="#examples-2">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">slab</span>: <span class="ident">Slab</span><span class="op"><</span><span class="ident">i32</span><span class="op">></span> <span class="op">=</span> <span class="ident">Slab</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">slab</span>.<span class="ident">capacity</span>(), <span class="number">10</span>);</pre>
|
||
</div><h4 id='method.reserve' class="method"><span id='reserve.v' class='invisible'><code>pub fn <a href='#method.reserve' class='fnname'>reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#269-275' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Reserve capacity for at least <code>additional</code> more values to be stored
|
||
without allocating.</p>
|
||
<p><code>reserve</code> does nothing if the slab already has sufficient capacity for
|
||
<code>additional</code> more values. If more capacity is required, a new segment of
|
||
memory will be allocated and all existing values will be copied into it.
|
||
As such, if the slab is already very large, a call to <code>reserve</code> can end
|
||
up being expensive.</p>
|
||
<p>The slab may reserve more than <code>additional</code> extra space in order to
|
||
avoid frequent reallocations. Use <code>reserve_exact</code> instead to guarantee
|
||
that only the requested space is allocated.</p>
|
||
<h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
|
||
<p>Panics if the new capacity overflows <code>usize</code>.</p>
|
||
<h1 id="examples-3" class="section-header"><a href="#examples-3">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
<span class="ident">slab</span>.<span class="ident">insert</span>(<span class="string">"hello"</span>);
|
||
<span class="ident">slab</span>.<span class="ident">reserve</span>(<span class="number">10</span>);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">capacity</span>() <span class="op">>=</span> <span class="number">11</span>);</pre>
|
||
</div><h4 id='method.reserve_exact' class="method"><span id='reserve_exact.v' class='invisible'><code>pub fn <a href='#method.reserve_exact' class='fnname'>reserve_exact</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#303-309' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Reserve the minimum capacity required to store exactly <code>additional</code>
|
||
more values.</p>
|
||
<p><code>reserve_exact</code> does nothing if the slab already has sufficient capacity
|
||
for <code>additional</code> more valus. If more capacity is required, a new segment
|
||
of memory will be allocated and all existing values will be copied into
|
||
it. As such, if the slab is already very large, a call to <code>reserve</code> can
|
||
end up being expensive.</p>
|
||
<p>Note that the allocator may give the slab more space than it requests.
|
||
Therefore capacity can not be relied upon to be precisely minimal.
|
||
Prefer <code>reserve</code> if future insertions are expected.</p>
|
||
<h1 id="panics-1" class="section-header"><a href="#panics-1">Panics</a></h1>
|
||
<p>Panics if the new capacity overflows <code>usize</code>.</p>
|
||
<h1 id="examples-4" class="section-header"><a href="#examples-4">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
<span class="ident">slab</span>.<span class="ident">insert</span>(<span class="string">"hello"</span>);
|
||
<span class="ident">slab</span>.<span class="ident">reserve_exact</span>(<span class="number">10</span>);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">capacity</span>() <span class="op">>=</span> <span class="number">11</span>);</pre>
|
||
</div><h4 id='method.shrink_to_fit' class="method"><span id='shrink_to_fit.v' class='invisible'><code>pub fn <a href='#method.shrink_to_fit' class='fnname'>shrink_to_fit</a>(&mut self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#351-353' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Shrink the capacity of the slab as much as possible.</p>
|
||
<p>It will drop down as close as possible to the length but the allocator
|
||
may still inform the vector that there is space for a few more elements.
|
||
Also, since values are not moved, the slab cannot shrink past any stored
|
||
values.</p>
|
||
<h1 id="examples-5" class="section-header"><a href="#examples-5">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">with_capacity</span>(<span class="number">10</span>);
|
||
|
||
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">3</span> {
|
||
<span class="ident">slab</span>.<span class="ident">insert</span>(<span class="ident">i</span>);
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">capacity</span>(), <span class="number">10</span>);
|
||
<span class="ident">slab</span>.<span class="ident">shrink_to_fit</span>();
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">capacity</span>() <span class="op">>=</span> <span class="number">3</span>);</pre>
|
||
<p>In this case, even though two values are removed, the slab cannot shrink
|
||
past the last value.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">with_capacity</span>(<span class="number">10</span>);
|
||
|
||
<span class="kw">for</span> <span class="ident">i</span> <span class="kw">in</span> <span class="number">0</span>..<span class="number">3</span> {
|
||
<span class="ident">slab</span>.<span class="ident">insert</span>(<span class="ident">i</span>);
|
||
}
|
||
|
||
<span class="ident">slab</span>.<span class="ident">remove</span>(<span class="number">0</span>);
|
||
<span class="ident">slab</span>.<span class="ident">remove</span>(<span class="number">1</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">capacity</span>(), <span class="number">10</span>);
|
||
<span class="ident">slab</span>.<span class="ident">shrink_to_fit</span>();
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">capacity</span>() <span class="op">>=</span> <span class="number">3</span>);</pre>
|
||
</div><h4 id='method.clear' class="method"><span id='clear.v' class='invisible'><code>pub fn <a href='#method.clear' class='fnname'>clear</a>(&mut self)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#370-374' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Clear the slab of all values.</p>
|
||
<h1 id="examples-6" class="section-header"><a href="#examples-6">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</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">3</span> {
|
||
<span class="ident">slab</span>.<span class="ident">insert</span>(<span class="ident">i</span>);
|
||
}
|
||
|
||
<span class="ident">slab</span>.<span class="ident">clear</span>();
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">is_empty</span>());</pre>
|
||
</div><h4 id='method.len' class="method"><span id='len.v' class='invisible'><code>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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#390-392' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return the number of stored values.</p>
|
||
<h1 id="examples-7" class="section-header"><a href="#examples-7">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</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">3</span> {
|
||
<span class="ident">slab</span>.<span class="ident">insert</span>(<span class="ident">i</span>);
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">3</span>, <span class="ident">slab</span>.<span class="ident">len</span>());</pre>
|
||
</div><h4 id='method.is_empty' class="method"><span id='is_empty.v' class='invisible'><code>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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#406-408' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return <code>true</code> if there are no values stored in the slab.</p>
|
||
<h1 id="examples-8" class="section-header"><a href="#examples-8">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">is_empty</span>());
|
||
|
||
<span class="ident">slab</span>.<span class="ident">insert</span>(<span class="number">1</span>);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">slab</span>.<span class="ident">is_empty</span>());</pre>
|
||
</div><h4 id='method.iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../slab/struct.Iter.html" title="struct slab::Iter">Iter</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../slab/struct.Iter.html" title="struct slab::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../slab/struct.Iter.html" title="struct slab::Iter">Iter</a><'a, T></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></div></div><span id='iter.v' class='invisible'><code>pub fn <a href='#method.iter' class='fnname'>iter</a>(&self) -> <a class="struct" href="../slab/struct.Iter.html" title="struct slab::Iter">Iter</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#434-439' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return an iterator over the slab.</p>
|
||
<p>This function should generally be <strong>avoided</strong> as it is not efficient.
|
||
Iterators must iterate over every slot in the slab even if it is
|
||
vacant. As such, a slab with a capacity of 1 million but only one
|
||
stored value must still iterate the million slots.</p>
|
||
<h1 id="examples-9" class="section-header"><a href="#examples-9">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</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">3</span> {
|
||
<span class="ident">slab</span>.<span class="ident">insert</span>(<span class="ident">i</span>);
|
||
}
|
||
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">iterator</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">iter</span>();
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iterator</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>((<span class="number">0</span>, <span class="kw-2">&</span><span class="number">0</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iterator</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>((<span class="number">1</span>, <span class="kw-2">&</span><span class="number">1</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iterator</span>.<span class="ident">next</span>(), <span class="prelude-val">Some</span>((<span class="number">2</span>, <span class="kw-2">&</span><span class="number">2</span>)));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">iterator</span>.<span class="ident">next</span>(), <span class="prelude-val">None</span>);</pre>
|
||
</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="../slab/struct.IterMut.html" title="struct slab::IterMut">IterMut</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../slab/struct.IterMut.html" title="struct slab::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../slab/struct.IterMut.html" title="struct slab::IterMut">IterMut</a><'a, T></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.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><span id='iter_mut.v' class='invisible'><code>pub fn <a href='#method.iter_mut' class='fnname'>iter_mut</a>(&mut self) -> <a class="struct" href="../slab/struct.IterMut.html" title="struct slab::IterMut">IterMut</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#466-471' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return an iterator that allows modifying each value.</p>
|
||
<p>This function should generally be <strong>avoided</strong> as it is not efficient.
|
||
Iterators must iterate over every slot in the slab even if it is
|
||
vacant. As such, a slab with a capacity of 1 million but only one
|
||
stored value must still iterate the million slots.</p>
|
||
<h1 id="examples-10" class="section-header"><a href="#examples-10">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">key1</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="number">0</span>);
|
||
<span class="kw">let</span> <span class="ident">key2</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="number">1</span>);
|
||
|
||
<span class="kw">for</span> (<span class="ident">key</span>, <span class="ident">val</span>) <span class="kw">in</span> <span class="ident">slab</span>.<span class="ident">iter_mut</span>() {
|
||
<span class="kw">if</span> <span class="ident">key</span> <span class="op">==</span> <span class="ident">key1</span> {
|
||
<span class="kw-2">*</span><span class="ident">val</span> <span class="op">+=</span> <span class="number">2</span>;
|
||
}
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>[<span class="ident">key1</span>], <span class="number">2</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>[<span class="ident">key2</span>], <span class="number">1</span>);</pre>
|
||
</div><h4 id='method.get' class="method"><span id='get.v' class='invisible'><code>pub fn <a href='#method.get' class='fnname'>get</a>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#488-493' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return a reference to the value associated with the given key.</p>
|
||
<p>If the given key is not associated with a value, then <code>None</code> is
|
||
returned.</p>
|
||
<h1 id="examples-11" class="section-header"><a href="#examples-11">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
<span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="string">"hello"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">get</span>(<span class="ident">key</span>), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"hello"</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">get</span>(<span class="number">123</span>), <span class="prelude-val">None</span>);</pre>
|
||
</div><h4 id='method.get_mut' class="method"><span id='get_mut.v' class='invisible'><code>pub fn <a href='#method.get_mut' class='fnname'>get_mut</a>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#512-517' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return a mutable reference to the value associated with the given key.</p>
|
||
<p>If the given key is not associated with a value, then <code>None</code> is
|
||
returned.</p>
|
||
<h1 id="examples-12" class="section-header"><a href="#examples-12">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
<span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="string">"hello"</span>);
|
||
|
||
<span class="kw-2">*</span><span class="ident">slab</span>.<span class="ident">get_mut</span>(<span class="ident">key</span>).<span class="ident">unwrap</span>() <span class="op">=</span> <span class="string">"world"</span>;
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>[<span class="ident">key</span>], <span class="string">"world"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">get_mut</span>(<span class="number">123</span>), <span class="prelude-val">None</span>);</pre>
|
||
</div><h4 id='method.get_unchecked' class="method"><span id='get_unchecked.v' class='invisible'><code>pub unsafe fn <a href='#method.get_unchecked' class='fnname'>get_unchecked</a>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#535-540' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return a reference to the value associated with the given key without
|
||
performing bounds checking.</p>
|
||
<p>This function should be used with care.</p>
|
||
<h1 id="examples-13" class="section-header"><a href="#examples-13">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
<span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="number">2</span>);
|
||
|
||
<span class="kw">unsafe</span> {
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">get_unchecked</span>(<span class="ident">key</span>), <span class="kw-2">&</span><span class="number">2</span>);
|
||
}</pre>
|
||
</div><h4 id='method.get_unchecked_mut' class="method"><span id='get_unchecked_mut.v' class='invisible'><code>pub unsafe fn <a href='#method.get_unchecked_mut' class='fnname'>get_unchecked_mut</a>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#561-566' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return a mutable reference to the value associated with the given key
|
||
without performing bounds checking.</p>
|
||
<p>This function should be used with care.</p>
|
||
<h1 id="examples-14" class="section-header"><a href="#examples-14">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
<span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="number">2</span>);
|
||
|
||
<span class="kw">unsafe</span> {
|
||
<span class="kw">let</span> <span class="ident">val</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">get_unchecked_mut</span>(<span class="ident">key</span>);
|
||
<span class="kw-2">*</span><span class="ident">val</span> <span class="op">=</span> <span class="number">13</span>;
|
||
}
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>[<span class="ident">key</span>], <span class="number">13</span>);</pre>
|
||
</div><h4 id='method.insert' class="method"><span id='insert.v' class='invisible'><code>pub fn <a href='#method.insert' class='fnname'>insert</a>(&mut self, val: T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#586-592' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Insert a value in the slab, returning key assigned to the value.</p>
|
||
<p>The returned key can later be used to retrieve or remove the value using indexed
|
||
lookup and <code>remove</code>. Additional capacity is allocated if needed. See
|
||
<a href="index.html#capacity-and-reallocation">Capacity and reallocation</a>.</p>
|
||
<h1 id="panics-2" class="section-header"><a href="#panics-2">Panics</a></h1>
|
||
<p>Panics if the number of elements in the vector overflows a <code>usize</code>.</p>
|
||
<h1 id="examples-15" class="section-header"><a href="#examples-15">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
<span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="string">"hello"</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>[<span class="ident">key</span>], <span class="string">"hello"</span>);</pre>
|
||
</div><h4 id='method.vacant_entry' class="method"><span id='vacant_entry.v' class='invisible'><code>pub fn <a href='#method.vacant_entry' class='fnname'>vacant_entry</a>(&mut self) -> <a class="struct" href="../slab/struct.VacantEntry.html" title="struct slab::VacantEntry">VacantEntry</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#617-622' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return a handle to a vacant entry allowing for further manipulation.</p>
|
||
<p>This function is useful when creating values that must contain their
|
||
slab key. The returned <code>VacantEntry</code> reserves a slot in the slab and is
|
||
able to query the associated key.</p>
|
||
<h1 id="examples-16" class="section-header"><a href="#examples-16">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">hello</span> <span class="op">=</span> {
|
||
<span class="kw">let</span> <span class="ident">entry</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">vacant_entry</span>();
|
||
<span class="kw">let</span> <span class="ident">key</span> <span class="op">=</span> <span class="ident">entry</span>.<span class="ident">key</span>();
|
||
|
||
<span class="ident">entry</span>.<span class="ident">insert</span>((<span class="ident">key</span>, <span class="string">"hello"</span>));
|
||
<span class="ident">key</span>
|
||
};
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">hello</span>, <span class="ident">slab</span>[<span class="ident">hello</span>].<span class="number">0</span>);
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="string">"hello"</span>, <span class="ident">slab</span>[<span class="ident">hello</span>].<span class="number">1</span>);</pre>
|
||
</div><h4 id='method.remove' class="method"><span id='remove.v' class='invisible'><code>pub fn <a href='#method.remove' class='fnname'>remove</a>(&mut self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#664-682' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Remove and return the value associated with the given key.</p>
|
||
<p>The key is then released and may be associated with future stored
|
||
values.</p>
|
||
<h1 id="panics-3" class="section-header"><a href="#panics-3">Panics</a></h1>
|
||
<p>Panics if <code>key</code> is not associated with a value.</p>
|
||
<h1 id="examples-17" class="section-header"><a href="#examples-17">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">hello</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="string">"hello"</span>);
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">remove</span>(<span class="ident">hello</span>), <span class="string">"hello"</span>);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">slab</span>.<span class="ident">contains</span>(<span class="ident">hello</span>));</pre>
|
||
</div><h4 id='method.contains' class="method"><span id='contains.v' class='invisible'><code>pub fn <a href='#method.contains' class='fnname'>contains</a>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#699-708' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Return <code>true</code> if a value is associated with the given key.</p>
|
||
<h1 id="examples-18" class="section-header"><a href="#examples-18">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">hello</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="string">"hello"</span>);
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">contains</span>(<span class="ident">hello</span>));
|
||
|
||
<span class="ident">slab</span>.<span class="ident">remove</span>(<span class="ident">hello</span>);
|
||
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">slab</span>.<span class="ident">contains</span>(<span class="ident">hello</span>));</pre>
|
||
</div><h4 id='method.retain' class="method"><span id='retain.v' class='invisible'><code>pub fn <a href='#method.retain' class='fnname'>retain</a><F>(&mut self, f: F) <span class="where fmt-newline">where<br> F: <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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>, </span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#734-747' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Retain only the elements specified by the predicate.</p>
|
||
<p>In other words, remove all elements <code>e</code> such that <code>f(usize, &mut e)</code>
|
||
returns false. This method operates in place and preserves the key
|
||
associated with the retained values.</p>
|
||
<h1 id="examples-19" class="section-header"><a href="#examples-19">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">slab</span> <span class="op">=</span> <span class="ident">Slab</span>::<span class="ident">new</span>();
|
||
|
||
<span class="kw">let</span> <span class="ident">k1</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="number">0</span>);
|
||
<span class="kw">let</span> <span class="ident">k2</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="number">1</span>);
|
||
<span class="kw">let</span> <span class="ident">k3</span> <span class="op">=</span> <span class="ident">slab</span>.<span class="ident">insert</span>(<span class="number">2</span>);
|
||
|
||
<span class="ident">slab</span>.<span class="ident">retain</span>(<span class="op">|</span><span class="ident">key</span>, <span class="ident">val</span><span class="op">|</span> <span class="ident">key</span> <span class="op">==</span> <span class="ident">k1</span> <span class="op">||</span> <span class="kw-2">*</span><span class="ident">val</span> <span class="op">==</span> <span class="number">1</span>);
|
||
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">contains</span>(<span class="ident">k1</span>));
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="ident">slab</span>.<span class="ident">contains</span>(<span class="ident">k2</span>));
|
||
<span class="macro">assert</span><span class="macro">!</span>(<span class="op">!</span><span class="ident">slab</span>.<span class="ident">contains</span>(<span class="ident">k3</span>));
|
||
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="number">2</span>, <span class="ident">slab</span>.<span class="ident">len</span>());</pre>
|
||
</div></div>
|
||
<h2 id='implementations' class='small-section-header'>
|
||
Trait Implementations<a href='#implementations' class='anchor'></a>
|
||
</h2>
|
||
<h3 id='impl-Clone' class='impl'><span class='in-band'><code>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="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code><a href='#impl-Clone' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#114' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.clone' class="method"><span id='clone.v' class='invisible'><code>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="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#114' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><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"><span id='clone_from.v' class='invisible'><code>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><span class='out-of-band'><div class='ghost'></div><div class='since' title='Stable since Rust version 1.0.0'>1.0.0</div><a class='srclink' href='https://doc.rust-lang.org/nightly/src/core/clone.rs.html#112-114' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><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-Default' class='impl'><span class='in-band'><code>impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code><a href='#impl-Default' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#127-131' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> Self</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#128-130' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div><h3 id='impl-Index%3Cusize%3E' class='impl'><span class='in-band'><code>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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> for <a class="struct" href="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code><a href='#impl-Index%3Cusize%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#750-759' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Output' class="type"><span id='Output.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#associatedtype.Output' class="type">Output</a> = T</code></span></h4>
|
||
<div class='docblock'><p>The returned type after indexing.</p>
|
||
</div><h4 id='method.index' class="method"><span id='index.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/ops/index/trait.Index.html#tymethod.index' class='fnname'>index</a>(&self, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#753-758' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Performs the indexing (<code>container[index]</code>) operation.</p>
|
||
</div></div><h3 id='impl-IndexMut%3Cusize%3E' class='impl'><span class='in-band'><code>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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>> for <a class="struct" href="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code><a href='#impl-IndexMut%3Cusize%3E' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#761-768' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.index_mut' class="method"><span id='index_mut.v' class='invisible'><code>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, key: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#762-767' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Performs the mutable indexing (<code>container[index]</code>) operation.</p>
|
||
</div></div><h3 id='impl-IntoIterator' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code><a href='#impl-IntoIterator' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#770-777' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Item' class="type"><span id='Item.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></h4>
|
||
<div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
</div><h4 id='associatedtype.IntoIter' class="type"><span id='IntoIter.t' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../slab/struct.Iter.html" title="struct slab::Iter">Iter</a><'a, T></code></span></h4>
|
||
<div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
</div><h4 id='method.into_iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../slab/struct.Iter.html" title="struct slab::Iter">Iter</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../slab/struct.Iter.html" title="struct slab::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../slab/struct.Iter.html" title="struct slab::Iter">Iter</a><'a, T></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a </a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;</span></code></div></div><span id='into_iter.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> <a class="struct" href="../slab/struct.Iter.html" title="struct slab::Iter">Iter</a><'a, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#774-776' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
</div></div><h3 id='impl-IntoIterator-1' class='impl'><span class='in-band'><code>impl<'a, T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html" title="trait core::iter::traits::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T></code><a href='#impl-IntoIterator-1' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#779-786' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='associatedtype.Item-1' class="type"><span id='Item.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&'a mut </a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></span></h4>
|
||
<div class='docblock'><p>The type of the elements being iterated over.</p>
|
||
</div><h4 id='associatedtype.IntoIter-1' class="type"><span id='IntoIter.t-1' class='invisible'><code>type <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#associatedtype.IntoIter' class="type">IntoIter</a> = <a class="struct" href="../slab/struct.IterMut.html" title="struct slab::IterMut">IterMut</a><'a, T></code></span></h4>
|
||
<div class='docblock'><p>Which kind of iterator are we turning this into?</p>
|
||
</div><h4 id='method.into_iter-1' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../slab/struct.IterMut.html" title="struct slab::IterMut">IterMut</a><'a, T></span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../slab/struct.IterMut.html" title="struct slab::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/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../slab/struct.IterMut.html" title="struct slab::IterMut">IterMut</a><'a, T></span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/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="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>, <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.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><span id='into_iter.v-1' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> <a class="struct" href="../slab/struct.IterMut.html" title="struct slab::IterMut">IterMut</a><'a, T></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#783-785' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><p>Creates an iterator from a value. <a href="https://doc.rust-lang.org/nightly/core/iter/traits/trait.IntoIterator.html#tymethod.into_iter">Read more</a></p>
|
||
</div></div><h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl<T> <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="../slab/struct.Slab.html" title="struct slab::Slab">Slab</a><T> <span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>, </span></code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#788-795' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, fmt: &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></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/slab/lib.rs.html#789-794' title='goto source code'>[src]</a></span></h4>
|
||
<div class='docblock'><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></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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../";
|
||
window.currentCrate = "slab";
|
||
</script>
|
||
<script src="../main.js"></script>
|
||
<script defer src="../search-index.js"></script>
|
||
</body>
|
||
</html> |