297 lines
86 KiB
HTML
297 lines
86 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="Hop slot map, storage with stable unique keys."><title>HopSlotMap in slotmap - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-42caa33d.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="slotmap" data-themes="" data-resource-suffix="" data-rustdoc-version="1.84.0 (9fc6b4312 2025-01-07)" data-channel="1.84.0" data-search-js="search-92e6798f.js" data-settings-js="settings-0f613d39.js" ><script src="../static.files/storage-59e33391.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-5f194d8c.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-893ab5e7.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-6580c154.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.svg"></head><body class="rustdoc struct"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../slotmap/index.html">slotmap</a><span class="version">1.0.7</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">HopSlot<wbr>Map</a></h2><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.capacity" title="capacity">capacity</a></li><li><a href="#method.clear" title="clear">clear</a></li><li><a href="#method.contains_key" title="contains_key">contains_key</a></li><li><a href="#method.drain" title="drain">drain</a></li><li><a href="#method.get" title="get">get</a></li><li><a href="#method.get_disjoint_mut" title="get_disjoint_mut">get_disjoint_mut</a></li><li><a href="#method.get_disjoint_unchecked_mut" title="get_disjoint_unchecked_mut">get_disjoint_unchecked_mut</a></li><li><a href="#method.get_mut" title="get_mut">get_mut</a></li><li><a href="#method.get_unchecked" title="get_unchecked">get_unchecked</a></li><li><a href="#method.get_unchecked_mut" title="get_unchecked_mut">get_unchecked_mut</a></li><li><a href="#method.insert" title="insert">insert</a></li><li><a href="#method.insert_with_key" title="insert_with_key">insert_with_key</a></li><li><a href="#method.is_empty" title="is_empty">is_empty</a></li><li><a href="#method.iter" title="iter">iter</a></li><li><a href="#method.iter_mut" title="iter_mut">iter_mut</a></li><li><a href="#method.keys" title="keys">keys</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.new" title="new">new</a></li><li><a href="#method.remove" title="remove">remove</a></li><li><a href="#method.reserve" title="reserve">reserve</a></li><li><a href="#method.retain" title="retain">retain</a></li><li><a href="#method.try_insert_with_key" title="try_insert_with_key">try_insert_with_key</a></li><li><a href="#method.values" title="values">values</a></li><li><a href="#method.values_mut" title="values_mut">values_mut</a></li><li><a href="#method.with_capacity" title="with_capacity">with_capacity</a></li><li><a href="#method.with_capacity_and_key" title="with_capacity_and_key">with_capacity_and_key</a></li><li><a href="#method.with_key" title="with_key">with_key</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block trait-implementation"><li><a href="#impl-Clone-for-HopSlotMap%3CK,+V%3E" title="Clone">Clone</a></li><li><a href="#impl-Debug-for-HopSlotMap%3CK,+V%3E" title="Debug">Debug</a></li><li><a href="#impl-Default-for-HopSlotMap%3CK,+V%3E" title="Default">Default</a></li><li><a href="#impl-Index%3CK%3E-for-HopSlotMap%3CK,+V%3E" title="Index<K>">Index<K></a></li><li><a href="#impl-IndexMut%3CK%3E-for-HopSlotMap%3CK,+V%3E" title="IndexMut<K>">IndexMut<K></a></li><li><a href="#impl-IntoIterator-for-%26HopSlotMap%3CK,+V%3E" title="IntoIterator">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-%26mut+HopSlotMap%3CK,+V%3E" title="IntoIterator">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-HopSlotMap%3CK,+V%3E" title="IntoIterator">IntoIterator</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block synthetic-implementation"><li><a href="#impl-Freeze-for-HopSlotMap%3CK,+V%3E" title="Freeze">Freeze</a></li><li><a href="#impl-RefUnwindSafe-for-HopSlotMap%3CK,+V%3E" title="RefUnwindSafe">RefUnwindSafe</a></li><li><a href="#impl-Send-for-HopSlotMap%3CK,+V%3E" title="Send">Send</a></li><li><a href="#impl-Sync-for-HopSlotMap%3CK,+V%3E" title="Sync">Sync</a></li><li><a href="#impl-Unpin-for-HopSlotMap%3CK,+V%3E" title="Unpin">Unpin</a></li><li><a href="#impl-UnwindSafe-for-HopSlotMap%3CK,+V%3E" title="UnwindSafe">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block blanket-implementation"><li><a href="#impl-Any-for-T" title="Any">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-T" title="Borrow<T>">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-T" title="BorrowMut<T>">BorrowMut<T></a></li><li><a href="#impl-CloneToUninit-for-T" title="CloneToUninit">CloneToUninit</a></li><li><a href="#impl-From%3CT%3E-for-T" title="From<T>">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-T" title="Into<U>">Into<U></a></li><li><a href="#impl-ToOwned-for-T" title="ToOwned">ToOwned</a></li><li><a href="#impl-TryFrom%3CU%3E-for-T" title="TryFrom<U>">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-T" title="TryInto<U>">TryInto<U></a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate slotmap</a></h2></div></div></nav><div class="sidebar-resizer"></div><main><div class="width-limiter"><rustdoc-search></rustdoc-search><section id="main-content" class="content"><div class="main-heading"><span class="rustdoc-breadcrumbs"><a href="index.html">slotmap</a></span><h1>Struct <span class="struct">HopSlotMap</span><button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/slotmap/hop.rs.html#148-152">Source</a> </span></div><pre class="rust item-decl"><code>pub struct HopSlotMap<K: <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V> { <span class="comment">/* private fields */</span> }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Hop slot map, storage with stable unique keys.</p>
|
|
<p>See <a href="index.html" title="mod slotmap">crate documentation</a> for more details.</p>
|
|
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-HopSlotMap%3CDefaultKey,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#154-181">Source</a><a href="#impl-HopSlotMap%3CDefaultKey,+V%3E" class="anchor">§</a><h3 class="code-header">impl<V> <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><<a class="struct" href="struct.DefaultKey.html" title="struct slotmap::DefaultKey">DefaultKey</a>, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.new" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#163-165">Source</a><h4 class="code-header">pub fn <a href="#method.new" class="fn">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Constructs a new, empty <a href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap"><code>HopSlotMap</code></a>.</p>
|
|
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm: HopSlotMap<<span class="kw">_</span>, i32> = HopSlotMap::new();</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_capacity" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#178-180">Source</a><h4 class="code-header">pub fn <a href="#method.with_capacity" class="fn">with_capacity</a>(capacity: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> Self</h4></section></summary><div class="docblock"><p>Creates an empty <a href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap"><code>HopSlotMap</code></a> with the given capacity.</p>
|
|
<p>The slot map will not reallocate until it holds at least <code>capacity</code>
|
|
elements.</p>
|
|
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm: HopSlotMap<<span class="kw">_</span>, i32> = HopSlotMap::with_capacity(<span class="number">10</span>);</code></pre></div>
|
|
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-HopSlotMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#183-982">Source</a><a href="#impl-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V> <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_key" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#195-197">Source</a><h4 class="code-header">pub fn <a href="#method.with_key" class="fn">with_key</a>() -> Self</h4></section></summary><div class="docblock"><p>Constructs a new, empty <a href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap"><code>HopSlotMap</code></a> with a custom key type.</p>
|
|
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">new_key_type!</span> {
|
|
<span class="kw">struct </span>PositionKey;
|
|
}
|
|
<span class="kw">let </span><span class="kw-2">mut </span>positions: HopSlotMap<PositionKey, i32> = HopSlotMap::with_key();</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_capacity_and_key" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#217-236">Source</a><h4 class="code-header">pub fn <a href="#method.with_capacity_and_key" class="fn">with_capacity_and_key</a>(capacity: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>) -> Self</h4></section></summary><div class="docblock"><p>Creates an empty <a href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap"><code>HopSlotMap</code></a> with the given capacity and a custom key
|
|
type.</p>
|
|
<p>The slot map will not reallocate until it holds at least <code>capacity</code>
|
|
elements.</p>
|
|
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="macro">new_key_type!</span> {
|
|
<span class="kw">struct </span>MessageKey;
|
|
}
|
|
<span class="kw">let </span><span class="kw-2">mut </span>messages = HopSlotMap::with_capacity_and_key(<span class="number">3</span>);
|
|
<span class="kw">let </span>welcome: MessageKey = messages.insert(<span class="string">"Welcome"</span>);
|
|
<span class="kw">let </span>good_day = messages.insert(<span class="string">"Good day"</span>);
|
|
<span class="kw">let </span>hello = messages.insert(<span class="string">"Hello"</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#250-252">Source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of elements in the slot map.</p>
|
|
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::with_capacity(<span class="number">10</span>);
|
|
sm.insert(<span class="string">"len() counts actual elements, not capacity"</span>);
|
|
<span class="kw">let </span>key = sm.insert(<span class="string">"removed elements don't count either"</span>);
|
|
sm.remove(key);
|
|
<span class="macro">assert_eq!</span>(sm.len(), <span class="number">1</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_empty" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#266-268">Source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns if the slot map is empty.</p>
|
|
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.insert(<span class="string">"dummy"</span>);
|
|
<span class="macro">assert_eq!</span>(sm.is_empty(), <span class="bool-val">false</span>);
|
|
sm.remove(key);
|
|
<span class="macro">assert_eq!</span>(sm.is_empty(), <span class="bool-val">true</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.capacity" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#280-283">Source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of elements the <a href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap"><code>HopSlotMap</code></a> can hold without
|
|
reallocating.</p>
|
|
<h5 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>sm: HopSlotMap<<span class="kw">_</span>, f64> = HopSlotMap::with_capacity(<span class="number">10</span>);
|
|
<span class="macro">assert_eq!</span>(sm.capacity(), <span class="number">10</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.reserve" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#302-306">Source</a><h4 class="code-header">pub fn <a href="#method.reserve" class="fn">reserve</a>(&mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Reserves capacity for at least <code>additional</code> more elements to be inserted
|
|
in the <a href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap"><code>HopSlotMap</code></a>. The collection may reserve more space to
|
|
avoid frequent reallocations.</p>
|
|
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
|
|
<p>Panics if the new allocation size overflows <a href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html" title="primitive usize"><code>usize</code></a>.</p>
|
|
<h5 id="examples-7"><a class="doc-anchor" href="#examples-7">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
sm.insert(<span class="string">"foo"</span>);
|
|
sm.reserve(<span class="number">32</span>);
|
|
<span class="macro">assert!</span>(sm.capacity() >= <span class="number">33</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.contains_key" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#341-346">Source</a><h4 class="code-header">pub fn <a href="#method.contains_key" class="fn">contains_key</a>(&self, key: K) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <a href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html" title="primitive bool"><code>true</code></a> if the slot map contains <code>key</code>.</p>
|
|
<h5 id="examples-8"><a class="doc-anchor" href="#examples-8">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.insert(<span class="number">42</span>);
|
|
<span class="macro">assert_eq!</span>(sm.contains_key(key), <span class="bool-val">true</span>);
|
|
sm.remove(key);
|
|
<span class="macro">assert_eq!</span>(sm.contains_key(key), <span class="bool-val">false</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#365-367">Source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(&mut self, value: V) -> K</h4></section></summary><div class="docblock"><p>Inserts a value into the slot map. Returns a unique key that can be
|
|
used to access this value.</p>
|
|
<h5 id="panics-1"><a class="doc-anchor" href="#panics-1">§</a>Panics</h5>
|
|
<p>Panics if the number of elements in the slot map equals
|
|
2<sup>32</sup> - 2.</p>
|
|
<h5 id="examples-9"><a class="doc-anchor" href="#examples-9">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.insert(<span class="number">42</span>);
|
|
<span class="macro">assert_eq!</span>(sm[key], <span class="number">42</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.insert_with_key" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#394-399">Source</a><h4 class="code-header">pub fn <a href="#method.insert_with_key" class="fn">insert_with_key</a><F>(&mut self, f: F) -> K<div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(K) -> V,</div></h4></section></summary><div class="docblock"><p>Inserts a value given by <code>f</code> into the slot map. The key where the
|
|
value will be stored is passed into <code>f</code>. This is useful to store values
|
|
that contain their own key.</p>
|
|
<h5 id="panics-2"><a class="doc-anchor" href="#panics-2">§</a>Panics</h5>
|
|
<p>Panics if the number of elements in the slot map equals
|
|
2<sup>32</sup> - 2.</p>
|
|
<h5 id="examples-10"><a class="doc-anchor" href="#examples-10">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.insert_with_key(|k| (k, <span class="number">20</span>));
|
|
<span class="macro">assert_eq!</span>(sm[key], (key, <span class="number">20</span>));</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_insert_with_key" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#422-483">Source</a><h4 class="code-header">pub fn <a href="#method.try_insert_with_key" class="fn">try_insert_with_key</a><F, E>(&mut self, f: F) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><K, E><div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(K) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><V, E>,</div></h4></section></summary><div class="docblock"><p>Inserts a value given by <code>f</code> into the slot map. The key where the
|
|
value will be stored is passed into <code>f</code>. This is useful to store values
|
|
that contain their own key.</p>
|
|
<p>If <code>f</code> returns <code>Err</code>, this method returns the error. The slotmap is untouched.</p>
|
|
<h5 id="panics-3"><a class="doc-anchor" href="#panics-3">§</a>Panics</h5>
|
|
<p>Panics if the number of elements in the slot map equals
|
|
2<sup>32</sup> - 2.</p>
|
|
<h5 id="examples-11"><a class="doc-anchor" href="#examples-11">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.try_insert_with_key::<<span class="kw">_</span>, ()>(|k| <span class="prelude-val">Ok</span>((k, <span class="number">20</span>))).unwrap();
|
|
<span class="macro">assert_eq!</span>(sm[key], (key, <span class="number">20</span>));
|
|
|
|
sm.try_insert_with_key::<<span class="kw">_</span>, ()>(|k| <span class="prelude-val">Err</span>(())).unwrap_err();</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#566-574">Source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a>(&mut self, key: K) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><V></h4></section></summary><div class="docblock"><p>Removes a key from the slot map, returning the value at the key if the
|
|
key was not previously removed.</p>
|
|
<h5 id="examples-12"><a class="doc-anchor" href="#examples-12">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.insert(<span class="number">42</span>);
|
|
<span class="macro">assert_eq!</span>(sm.remove(key), <span class="prelude-val">Some</span>(<span class="number">42</span>));
|
|
<span class="macro">assert_eq!</span>(sm.remove(key), <span class="prelude-val">None</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.retain" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#599-627">Source</a><h4 class="code-header">pub fn <a href="#method.retain" class="fn">retain</a><F>(&mut self, f: F)<div class="where">where
|
|
F: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(K, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Retains only the elements specified by the predicate.</p>
|
|
<p>In other words, remove all key-value pairs <code>(k, v)</code> such that
|
|
<code>f(k, &mut v)</code> returns false. This method invalidates any removed keys.</p>
|
|
<h5 id="examples-13"><a class="doc-anchor" href="#examples-13">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
|
|
<span class="kw">let </span>k1 = sm.insert(<span class="number">0</span>);
|
|
<span class="kw">let </span>k2 = sm.insert(<span class="number">1</span>);
|
|
<span class="kw">let </span>k3 = sm.insert(<span class="number">2</span>);
|
|
|
|
sm.retain(|key, val| key == k1 || <span class="kw-2">*</span>val == <span class="number">1</span>);
|
|
|
|
<span class="macro">assert!</span>(sm.contains_key(k1));
|
|
<span class="macro">assert!</span>(sm.contains_key(k2));
|
|
<span class="macro">assert!</span>(!sm.contains_key(k3));
|
|
|
|
<span class="macro">assert_eq!</span>(<span class="number">2</span>, sm.len());</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#643-645">Source</a><h4 class="code-header">pub fn <a href="#method.clear" class="fn">clear</a>(&mut self)</h4></section></summary><div class="docblock"><p>Clears the slot map. Keeps the allocated memory for reuse.</p>
|
|
<h5 id="examples-14"><a class="doc-anchor" href="#examples-14">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{
|
|
sm.insert(i);
|
|
}
|
|
<span class="macro">assert_eq!</span>(sm.len(), <span class="number">10</span>);
|
|
sm.clear();
|
|
<span class="macro">assert_eq!</span>(sm.len(), <span class="number">0</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.drain" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#665-670">Source</a><h4 class="code-header">pub fn <a href="#method.drain" class="fn">drain</a>(&mut self) -> <a class="struct" href="hop/struct.Drain.html" title="struct slotmap::hop::Drain">Drain</a><'_, K, V> <a href="#" class="tooltip" data-notable-ty="Drain<'_, K, V>">ⓘ</a></h4></section></summary><div class="docblock"><p>Clears the slot map, returning all key-value pairs in arbitrary order as
|
|
an iterator. Keeps the allocated memory for reuse.</p>
|
|
<p>When the iterator is dropped all elements in the slot map are removed,
|
|
even if the iterator was not fully consumed. If the iterator is not
|
|
dropped (using e.g. <a href="https://doc.rust-lang.org/1.84.0/core/mem/fn.forget.html" title="fn core::mem::forget"><code>std::mem::forget</code></a>), only the elements that were
|
|
iterated over are removed.</p>
|
|
<h5 id="examples-15"><a class="doc-anchor" href="#examples-15">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>k = sm.insert(<span class="number">0</span>);
|
|
<span class="kw">let </span>v: Vec<<span class="kw">_</span>> = sm.drain().collect();
|
|
<span class="macro">assert_eq!</span>(sm.len(), <span class="number">0</span>);
|
|
<span class="macro">assert_eq!</span>(v, <span class="macro">vec!</span>[(k, <span class="number">0</span>)]);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#684-692">Source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>(&self, key: K) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&V</a>></h4></section></summary><div class="docblock"><p>Returns a reference to the value corresponding to the key.</p>
|
|
<h5 id="examples-16"><a class="doc-anchor" href="#examples-16">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.insert(<span class="string">"bar"</span>);
|
|
<span class="macro">assert_eq!</span>(sm.get(key), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"bar"</span>));
|
|
sm.remove(key);
|
|
<span class="macro">assert_eq!</span>(sm.get(key), <span class="prelude-val">None</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_unchecked" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#712-715">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_unchecked" class="fn">get_unchecked</a>(&self, key: K) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&V</a></h4></section></summary><div class="docblock"><p>Returns a reference to the value corresponding to the key without
|
|
version or bounds checking.</p>
|
|
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
|
|
<p>This should only be used if <code>contains_key(key)</code> is true. Otherwise it is
|
|
dangerous undefined behavior.</p>
|
|
<h5 id="examples-17"><a class="doc-anchor" href="#examples-17">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.insert(<span class="string">"bar"</span>);
|
|
<span class="macro">assert_eq!</span>(<span class="kw">unsafe </span>{ sm.get_unchecked(key) }, <span class="kw-2">&</span><span class="string">"bar"</span>);
|
|
sm.remove(key);
|
|
<span class="comment">// sm.get_unchecked(key) is now dangerous!</span></code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_mut" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#730-738">Source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_mut</a>(&mut self, key: K) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the value corresponding to the key.</p>
|
|
<h5 id="examples-18"><a class="doc-anchor" href="#examples-18">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.insert(<span class="number">3.5</span>);
|
|
<span class="kw">if let </span><span class="prelude-val">Some</span>(x) = sm.get_mut(key) {
|
|
<span class="kw-2">*</span>x += <span class="number">3.0</span>;
|
|
}
|
|
<span class="macro">assert_eq!</span>(sm[key], <span class="number">6.5</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_unchecked_mut" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#759-762">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_unchecked_mut" class="fn">get_unchecked_mut</a>(&mut self, key: K) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the value corresponding to the key
|
|
without version or bounds checking.</p>
|
|
<h5 id="safety-1"><a class="doc-anchor" href="#safety-1">§</a>Safety</h5>
|
|
<p>This should only be used if <code>contains_key(key)</code> is true. Otherwise it is
|
|
dangerous undefined behavior.</p>
|
|
<h5 id="examples-19"><a class="doc-anchor" href="#examples-19">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>key = sm.insert(<span class="string">"foo"</span>);
|
|
<span class="kw">unsafe </span>{ <span class="kw-2">*</span>sm.get_unchecked_mut(key) = <span class="string">"bar" </span>};
|
|
<span class="macro">assert_eq!</span>(sm[key], <span class="string">"bar"</span>);
|
|
sm.remove(key);
|
|
<span class="comment">// sm.get_unchecked_mut(key) is now dangerous!</span></code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_disjoint_mut" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#787-826">Source</a><h4 class="code-header">pub fn <a href="#method.get_disjoint_mut" class="fn">get_disjoint_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>>(
|
|
&mut self,
|
|
keys: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">[K; N]</a>,
|
|
) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a><[<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">N</a>]></h4></section></summary><div class="docblock"><p>Returns mutable references to the values corresponding to the given
|
|
keys. All keys must be valid and disjoint, otherwise <a href="https://doc.rust-lang.org/1.84.0/core/option/enum.Option.html#variant.None" title="variant core::option::Option::None"><code>None</code></a> is
|
|
returned.</p>
|
|
<p>Requires at least stable Rust version 1.51.</p>
|
|
<h5 id="examples-20"><a class="doc-anchor" href="#examples-20">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>ka = sm.insert(<span class="string">"butter"</span>);
|
|
<span class="kw">let </span>kb = sm.insert(<span class="string">"apples"</span>);
|
|
<span class="kw">let </span>kc = sm.insert(<span class="string">"charlie"</span>);
|
|
sm.remove(kc); <span class="comment">// Make key c invalid.
|
|
</span><span class="macro">assert_eq!</span>(sm.get_disjoint_mut([ka, kb, kc]), <span class="prelude-val">None</span>); <span class="comment">// Has invalid key.
|
|
</span><span class="macro">assert_eq!</span>(sm.get_disjoint_mut([ka, ka]), <span class="prelude-val">None</span>); <span class="comment">// Not disjoint.
|
|
</span><span class="kw">let </span>[a, b] = sm.get_disjoint_mut([ka, kb]).unwrap();
|
|
std::mem::swap(a, b);
|
|
<span class="macro">assert_eq!</span>(sm[ka], <span class="string">"apples"</span>);
|
|
<span class="macro">assert_eq!</span>(sm[kb], <span class="string">"butter"</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_disjoint_unchecked_mut" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#851-861">Source</a><h4 class="code-header">pub unsafe fn <a href="#method.get_disjoint_unchecked_mut" class="fn">get_disjoint_unchecked_mut</a><const N: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.usize.html">usize</a>>(
|
|
&mut self,
|
|
keys: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">[K; N]</a>,
|
|
) -> [<a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a>; <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.array.html">N</a>]</h4></section></summary><div class="docblock"><p>Returns mutable references to the values corresponding to the given
|
|
keys. All keys must be valid and disjoint.</p>
|
|
<p>Requires at least stable Rust version 1.51.</p>
|
|
<h5 id="safety-2"><a class="doc-anchor" href="#safety-2">§</a>Safety</h5>
|
|
<p>This should only be used if <code>contains_key(key)</code> is true for every given
|
|
key and no two keys are equal. Otherwise it is potentially unsafe.</p>
|
|
<h5 id="examples-21"><a class="doc-anchor" href="#examples-21">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>ka = sm.insert(<span class="string">"butter"</span>);
|
|
<span class="kw">let </span>kb = sm.insert(<span class="string">"apples"</span>);
|
|
<span class="kw">let </span>[a, b] = <span class="kw">unsafe </span>{ sm.get_disjoint_unchecked_mut([ka, kb]) };
|
|
std::mem::swap(a, b);
|
|
<span class="macro">assert_eq!</span>(sm[ka], <span class="string">"apples"</span>);
|
|
<span class="macro">assert_eq!</span>(sm[kb], <span class="string">"butter"</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#879-886">Source</a><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> <a class="struct" href="hop/struct.Iter.html" title="struct slotmap::hop::Iter">Iter</a><'_, K, V> <a href="#" class="tooltip" data-notable-ty="Iter<'_, K, V>">ⓘ</a></h4></section></summary><div class="docblock"><p>An iterator visiting all key-value pairs in arbitrary order. The
|
|
iterator element type is <code>(K, &'a V)</code>.</p>
|
|
<h5 id="examples-22"><a class="doc-anchor" href="#examples-22">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>k0 = sm.insert(<span class="number">0</span>);
|
|
<span class="kw">let </span>k1 = sm.insert(<span class="number">1</span>);
|
|
<span class="kw">let </span>k2 = sm.insert(<span class="number">2</span>);
|
|
|
|
<span class="kw">for </span>(k, v) <span class="kw">in </span>sm.iter() {
|
|
<span class="macro">println!</span>(<span class="string">"key: {:?}, val: {}"</span>, k, v);
|
|
}</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter_mut" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#911-918">Source</a><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fn">iter_mut</a>(&mut self) -> <a class="struct" href="hop/struct.IterMut.html" title="struct slotmap::hop::IterMut">IterMut</a><'_, K, V> <a href="#" class="tooltip" data-notable-ty="IterMut<'_, K, V>">ⓘ</a></h4></section></summary><div class="docblock"><p>An iterator visiting all key-value pairs in arbitrary order, with
|
|
mutable references to the values. The iterator element type is
|
|
<code>(K, &'a mut V)</code>.</p>
|
|
<h5 id="examples-23"><a class="doc-anchor" href="#examples-23">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>k0 = sm.insert(<span class="number">10</span>);
|
|
<span class="kw">let </span>k1 = sm.insert(<span class="number">20</span>);
|
|
<span class="kw">let </span>k2 = sm.insert(<span class="number">30</span>);
|
|
|
|
<span class="kw">for </span>(k, v) <span class="kw">in </span>sm.iter_mut() {
|
|
<span class="kw">if </span>k != k1 {
|
|
<span class="kw-2">*</span>v <span class="kw-2">*</span>= -<span class="number">1</span>;
|
|
}
|
|
}
|
|
|
|
<span class="macro">assert_eq!</span>(sm[k0], -<span class="number">10</span>);
|
|
<span class="macro">assert_eq!</span>(sm[k1], <span class="number">20</span>);
|
|
<span class="macro">assert_eq!</span>(sm[k2], -<span class="number">30</span>);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.keys" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#936-938">Source</a><h4 class="code-header">pub fn <a href="#method.keys" class="fn">keys</a>(&self) -> <a class="struct" href="hop/struct.Keys.html" title="struct slotmap::hop::Keys">Keys</a><'_, K, V> <a href="#" class="tooltip" data-notable-ty="Keys<'_, K, V>">ⓘ</a></h4></section></summary><div class="docblock"><p>An iterator visiting all keys in arbitrary order. The iterator element
|
|
type is <code>K</code>.</p>
|
|
<h5 id="examples-24"><a class="doc-anchor" href="#examples-24">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>k0 = sm.insert(<span class="number">10</span>);
|
|
<span class="kw">let </span>k1 = sm.insert(<span class="number">20</span>);
|
|
<span class="kw">let </span>k2 = sm.insert(<span class="number">30</span>);
|
|
<span class="kw">let </span>keys: HashSet<<span class="kw">_</span>> = sm.keys().collect();
|
|
<span class="kw">let </span>check: HashSet<<span class="kw">_</span>> = <span class="macro">vec!</span>[k0, k1, k2].into_iter().collect();
|
|
<span class="macro">assert_eq!</span>(keys, check);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.values" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#956-958">Source</a><h4 class="code-header">pub fn <a href="#method.values" class="fn">values</a>(&self) -> <a class="struct" href="hop/struct.Values.html" title="struct slotmap::hop::Values">Values</a><'_, K, V> <a href="#" class="tooltip" data-notable-ty="Values<'_, K, V>">ⓘ</a></h4></section></summary><div class="docblock"><p>An iterator visiting all values in arbitrary order. The iterator element
|
|
type is <code>&'a V</code>.</p>
|
|
<h5 id="examples-25"><a class="doc-anchor" href="#examples-25">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
<span class="kw">let </span>k0 = sm.insert(<span class="number">10</span>);
|
|
<span class="kw">let </span>k1 = sm.insert(<span class="number">20</span>);
|
|
<span class="kw">let </span>k2 = sm.insert(<span class="number">30</span>);
|
|
<span class="kw">let </span>values: HashSet<<span class="kw">_</span>> = sm.values().collect();
|
|
<span class="kw">let </span>check: HashSet<<span class="kw">_</span>> = <span class="macro">vec!</span>[<span class="kw-2">&</span><span class="number">10</span>, <span class="kw-2">&</span><span class="number">20</span>, <span class="kw-2">&</span><span class="number">30</span>].into_iter().collect();
|
|
<span class="macro">assert_eq!</span>(values, check);</code></pre></div>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.values_mut" class="method"><a class="src rightside" href="../src/slotmap/hop.rs.html#977-981">Source</a><h4 class="code-header">pub fn <a href="#method.values_mut" class="fn">values_mut</a>(&mut self) -> <a class="struct" href="hop/struct.ValuesMut.html" title="struct slotmap::hop::ValuesMut">ValuesMut</a><'_, K, V> <a href="#" class="tooltip" data-notable-ty="ValuesMut<'_, K, V>">ⓘ</a></h4></section></summary><div class="docblock"><p>An iterator visiting all values mutably in arbitrary order. The iterator
|
|
element type is <code>&'a mut V</code>.</p>
|
|
<h5 id="examples-26"><a class="doc-anchor" href="#examples-26">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>sm = HopSlotMap::new();
|
|
sm.insert(<span class="number">1</span>);
|
|
sm.insert(<span class="number">2</span>);
|
|
sm.insert(<span class="number">3</span>);
|
|
sm.values_mut().for_each(|n| { <span class="kw-2">*</span>n <span class="kw-2">*</span>= <span class="number">3 </span>});
|
|
<span class="kw">let </span>values: HashSet<<span class="kw">_</span>> = sm.into_iter().map(|(_k, v)| v).collect();
|
|
<span class="kw">let </span>check: HashSet<<span class="kw">_</span>> = <span class="macro">vec!</span>[<span class="number">3</span>, <span class="number">6</span>, <span class="number">9</span>].into_iter().collect();
|
|
<span class="macro">assert_eq!</span>(values, check);</code></pre></div>
|
|
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-HopSlotMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#984-999">Source</a><a href="#impl-Clone-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V><div class="where">where
|
|
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone" class="method trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#988-993">Source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&self) -> Self</h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#995-998">Source</a><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-HopSlotMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#147">Source</a><a href="#impl-Debug-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#147">Source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/1.84.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.84.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-HopSlotMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1001-1005">Source</a><a href="#impl-Default-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.default" class="method trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1002-1004">Source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -> Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/1.84.0/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Index%3CK%3E-for-HopSlotMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1007-1016">Source</a><a href="#impl-Index%3CK%3E-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.Index.html" title="trait core::ops::index::Index">Index</a><K> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1008">Source</a><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.Index.html#associatedtype.Output" class="associatedtype">Output</a> = V</h4></section></summary><div class='docblock'>The returned type after indexing.</div></details><details class="toggle method-toggle" open><summary><section id="method.index" class="method trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1010-1015">Source</a><a href="#method.index" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.Index.html#tymethod.index" class="fn">index</a>(&self, key: K) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&V</a></h4></section></summary><div class='docblock'>Performs the indexing (<code>container[index]</code>) operation. <a href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.Index.html#tymethod.index">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IndexMut%3CK%3E-for-HopSlotMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1018-1025">Source</a><a href="#impl-IndexMut%3CK%3E-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.IndexMut.html" title="trait core::ops::index::IndexMut">IndexMut</a><K> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.index_mut" class="method trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1019-1024">Source</a><a href="#method.index_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.IndexMut.html#tymethod.index_mut" class="fn">index_mut</a>(&mut self, key: K) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut V</a></h4></section></summary><div class='docblock'>Performs the mutable indexing (<code>container[index]</code>) operation. <a href="https://doc.rust-lang.org/1.84.0/core/ops/index/trait.IndexMut.html#tymethod.index_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26HopSlotMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1290-1297">Source</a><a href="#impl-IntoIterator-for-%26HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K: <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1291">Source</a><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = (K, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a V</a>)</h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter" class="associatedtype trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1292">Source</a><a href="#associatedtype.IntoIter" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="hop/struct.Iter.html" title="struct slotmap::hop::Iter">Iter</a><'a, K, V></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter" class="method trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1294-1296">Source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26mut+HopSlotMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1299-1306">Source</a><a href="#impl-IntoIterator-for-%26mut+HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K: <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &'a mut <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1300">Source</a><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = (K, <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&'a mut V</a>)</h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1301">Source</a><a href="#associatedtype.IntoIter-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="hop/struct.IterMut.html" title="struct slotmap::hop::IterMut">IterMut</a><'a, K, V></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter-1" class="method trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1303-1305">Source</a><a href="#method.into_iter-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-HopSlotMap%3CK,+V%3E" class="impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1308-1320">Source</a><a href="#impl-IntoIterator-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K: <a class="trait" href="trait.Key.html" title="trait slotmap::Key">Key</a>, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1309">Source</a><a href="#associatedtype.Item-2" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html">(K, V)</a></h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1310">Source</a><a href="#associatedtype.IntoIter-2" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="hop/struct.IntoIter.html" title="struct slotmap::hop::IntoIter">IntoIter</a><K, V></h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details><details class="toggle method-toggle" open><summary><section id="method.into_iter-2" class="method trait-impl"><a class="src rightside" href="../src/slotmap/hop.rs.html#1312-1319">Source</a><a href="#method.into_iter-2" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -> Self::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" title="type core::iter::traits::collect::IntoIterator::IntoIter">IntoIter</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.84.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-HopSlotMap%3CK,+V%3E" class="impl"><a href="#impl-Freeze-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V></h3></section><section id="impl-RefUnwindSafe-for-HopSlotMap%3CK,+V%3E" class="impl"><a href="#impl-RefUnwindSafe-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V><div class="where">where
|
|
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-HopSlotMap%3CK,+V%3E" class="impl"><a href="#impl-Send-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V><div class="where">where
|
|
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-HopSlotMap%3CK,+V%3E" class="impl"><a href="#impl-Sync-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V><div class="where">where
|
|
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-HopSlotMap%3CK,+V%3E" class="impl"><a href="#impl-Unpin-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V><div class="where">where
|
|
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-HopSlotMap%3CK,+V%3E" class="impl"><a href="#impl-UnwindSafe-for-HopSlotMap%3CK,+V%3E" class="anchor">§</a><h3 class="code-header">impl<K, V> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.HopSlotMap.html" title="struct slotmap::HopSlotMap">HopSlotMap</a><K, V><div class="where">where
|
|
V: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#138">Source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
|
|
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/any.rs.html#139">Source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/1.84.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.84.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#209">Source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#211">Source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#217">Source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<div class="where">where
|
|
T: ?<a class="trait" href="https://doc.rust-lang.org/1.84.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/borrow.rs.html#218">Source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.84.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#273">Source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/clone.rs.html#275">Source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&self, dst: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.pointer.html">*mut </a><a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.u8.html">u8</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dst</code>. <a href="https://doc.rust-lang.org/1.84.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#765">Source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#768">Source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#748-750">Source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#758">Source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
|
|
<p>That is, this conversion is whatever the implementation of
|
|
<code><a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for U</code> chooses to do.</p>
|
|
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#82-84">Source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
|
|
T: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#86">Source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#87">Source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&self) -> T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/alloc/borrow.rs.html#91">Source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&self, target: <a class="primitive" href="https://doc.rust-lang.org/1.84.0/std/primitive.reference.html">&mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.84.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#805-807">Source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#809">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#812">Source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#790-792">Source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<div class="where">where
|
|
U: <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#794">Source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.84.0/src/core/convert/mod.rs.html#797">Source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/1.84.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/1.84.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div><script type="text/json" id="notable-traits-data">{"Drain<'_, K, V>":"<h3>Notable traits for <code><a class=\"struct\" href=\"hop/struct.Drain.html\" title=\"struct slotmap::hop::Drain\">Drain</a><'a, K, V></code></h3><pre><code><div class=\"where\">impl<'a, K: <a class=\"trait\" href=\"trait.Key.html\" title=\"trait slotmap::Key\">Key</a>, V> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"hop/struct.Drain.html\" title=\"struct slotmap::hop::Drain\">Drain</a><'a, K, V></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.0/std/primitive.tuple.html\">(K, V)</a>;</div>","Iter<'_, K, V>":"<h3>Notable traits for <code><a class=\"struct\" href=\"hop/struct.Iter.html\" title=\"struct slotmap::hop::Iter\">Iter</a><'a, K, V></code></h3><pre><code><div class=\"where\">impl<'a, K: <a class=\"trait\" href=\"trait.Key.html\" title=\"trait slotmap::Key\">Key</a>, V> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"hop/struct.Iter.html\" title=\"struct slotmap::hop::Iter\">Iter</a><'a, K, V></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = (K, <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.0/std/primitive.reference.html\">&'a V</a>);</div>","IterMut<'_, K, V>":"<h3>Notable traits for <code><a class=\"struct\" href=\"hop/struct.IterMut.html\" title=\"struct slotmap::hop::IterMut\">IterMut</a><'a, K, V></code></h3><pre><code><div class=\"where\">impl<'a, K: <a class=\"trait\" href=\"trait.Key.html\" title=\"trait slotmap::Key\">Key</a>, V> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"hop/struct.IterMut.html\" title=\"struct slotmap::hop::IterMut\">IterMut</a><'a, K, V></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = (K, <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.0/std/primitive.reference.html\">&'a mut V</a>);</div>","Keys<'_, K, V>":"<h3>Notable traits for <code><a class=\"struct\" href=\"hop/struct.Keys.html\" title=\"struct slotmap::hop::Keys\">Keys</a><'a, K, V></code></h3><pre><code><div class=\"where\">impl<'a, K: <a class=\"trait\" href=\"trait.Key.html\" title=\"trait slotmap::Key\">Key</a>, V> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"hop/struct.Keys.html\" title=\"struct slotmap::hop::Keys\">Keys</a><'a, K, V></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = K;</div>","Values<'_, K, V>":"<h3>Notable traits for <code><a class=\"struct\" href=\"hop/struct.Values.html\" title=\"struct slotmap::hop::Values\">Values</a><'a, K, V></code></h3><pre><code><div class=\"where\">impl<'a, K: <a class=\"trait\" href=\"trait.Key.html\" title=\"trait slotmap::Key\">Key</a>, V> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"hop/struct.Values.html\" title=\"struct slotmap::hop::Values\">Values</a><'a, K, V></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.0/std/primitive.reference.html\">&'a V</a>;</div>","ValuesMut<'_, K, V>":"<h3>Notable traits for <code><a class=\"struct\" href=\"hop/struct.ValuesMut.html\" title=\"struct slotmap::hop::ValuesMut\">ValuesMut</a><'a, K, V></code></h3><pre><code><div class=\"where\">impl<'a, K: <a class=\"trait\" href=\"trait.Key.html\" title=\"trait slotmap::Key\">Key</a>, V> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"hop/struct.ValuesMut.html\" title=\"struct slotmap::hop::ValuesMut\">ValuesMut</a><'a, K, V></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.84.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.84.0/std/primitive.reference.html\">&'a mut V</a>;</div>"}</script></section></div></main></body></html> |