306 lines
No EOL
68 KiB
HTML
306 lines
No EOL
68 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="Fixed capacity `IndexMap`"><title>IndexMap in arduboy_rust::heapless - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Bold-a2c9cd1067f8b328.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-cb6f1f67f1bcd037.css" id="mainThemeStyle"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="arduboy_rust" data-themes="" data-resource-suffix="" data-rustdoc-version="1.73.0-nightly (8131b9774 2023-08-02)" data-channel="nightly" data-search-js="search-6dfdfced5eff6596.js" data-settings-js="settings-de11bff964e9d4e5.js" data-settings-css="settings-8c76f75bfb6bd192.css" data-theme-light-css="light-6d2c9675f3d09c26.css" data-theme-dark-css="dark-45ceb8f2e522f4d1.css" data-theme-ayu-css="ayu-fd19013d6ce078bf.css" ><script src="../../static.files/storage-db41da1a38ea3cb8.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-0795b7d26be81095.js"></script><noscript><link rel="stylesheet" media="(prefers-color-scheme:light)" href="../../static.files/light-6d2c9675f3d09c26.css"><link rel="stylesheet" media="(prefers-color-scheme:dark)" href="../../static.files/dark-45ceb8f2e522f4d1.css"><link rel="stylesheet" href="../../static.files/noscript-cffde32267a19fd6.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.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">☰</button><a class="logo-container" href="../../arduboy_rust/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2></h2></nav><nav class="sidebar"><a class="logo-container" href="../../arduboy_rust/index.html"><img class="rust-logo" src="../../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">IndexMap</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.capacity">capacity</a></li><li><a href="#method.clear">clear</a></li><li><a href="#method.contains_key">contains_key</a></li><li><a href="#method.entry">entry</a></li><li><a href="#method.first">first</a></li><li><a href="#method.first_mut">first_mut</a></li><li><a href="#method.get">get</a></li><li><a href="#method.get_mut">get_mut</a></li><li><a href="#method.insert">insert</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.iter">iter</a></li><li><a href="#method.iter_mut">iter_mut</a></li><li><a href="#method.keys">keys</a></li><li><a href="#method.last">last</a></li><li><a href="#method.last_mut">last_mut</a></li><li><a href="#method.len">len</a></li><li><a href="#method.new">new</a></li><li><a href="#method.remove">remove</a></li><li><a href="#method.swap_remove">swap_remove</a></li><li><a href="#method.values">values</a></li><li><a href="#method.values_mut">values_mut</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-IndexMap%3CK,+V,+S,+N%3E">Clone</a></li><li><a href="#impl-Debug-for-IndexMap%3CK,+V,+S,+N%3E">Debug</a></li><li><a href="#impl-Default-for-IndexMap%3CK,+V,+S,+N%3E">Default</a></li><li><a href="#impl-Eq-for-IndexMap%3CK,+V,+S,+N%3E">Eq</a></li><li><a href="#impl-Extend%3C(%26'a+K,+%26'a+V)%3E-for-IndexMap%3CK,+V,+S,+N%3E">Extend<(&'a K, &'a V)></a></li><li><a href="#impl-Extend%3C(K,+V)%3E-for-IndexMap%3CK,+V,+S,+N%3E">Extend<(K, V)></a></li><li><a href="#impl-FromIterator%3C(K,+V)%3E-for-IndexMap%3CK,+V,+S,+N%3E">FromIterator<(K, V)></a></li><li><a href="#impl-Index%3C%26'a+Q%3E-for-IndexMap%3CK,+V,+S,+N%3E">Index<&'a Q></a></li><li><a href="#impl-IndexMut%3C%26'a+Q%3E-for-IndexMap%3CK,+V,+S,+N%3E">IndexMut<&'a Q></a></li><li><a href="#impl-IntoIterator-for-%26'a+IndexMap%3CK,+V,+S,+N%3E">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-%26'a+mut+IndexMap%3CK,+V,+S,+N%3E">IntoIterator</a></li><li><a href="#impl-IntoIterator-for-IndexMap%3CK,+V,+S,+N%3E">IntoIterator</a></li><li><a href="#impl-PartialEq%3CIndexMap%3CK,+V,+S2,+N2%3E%3E-for-IndexMap%3CK,+V,+S,+N%3E">PartialEq<IndexMap<K, V, S2, N2>></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-IndexMap%3CK,+V,+S,+N%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-IndexMap%3CK,+V,+S,+N%3E">Send</a></li><li><a href="#impl-Sync-for-IndexMap%3CK,+V,+S,+N%3E">Sync</a></li><li><a href="#impl-Unpin-for-IndexMap%3CK,+V,+S,+N%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-IndexMap%3CK,+V,+S,+N%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-IndexMap%3CK,+V,+S,+N%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-IndexMap%3CK,+V,+S,+N%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-IndexMap%3CK,+V,+S,+N%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-IndexMap%3CK,+V,+S,+N%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-IndexMap%3CK,+V,+S,+N%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-IndexMap%3CK,+V,+S,+N%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-IndexMap%3CK,+V,+S,+N%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In arduboy_rust::heapless</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Struct <a href="../index.html">arduboy_rust</a>::<wbr><a href="index.html">heapless</a>::<wbr><a class="struct" href="#">IndexMap</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/heapless/indexmap.rs.html#475">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct IndexMap<K, V, S, const N: usize> { /* private fields */ }</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Fixed capacity <a href="https://docs.rs/indexmap/1/indexmap/map/struct.IndexMap.html"><code>IndexMap</code></a></p>
|
||
<p>Note that you cannot use <code>IndexMap</code> directly, since it is generic around the hashing algorithm
|
||
in use. Pick a concrete instantiation like <a href="./type.FnvIndexMap.html"><code>FnvIndexMap</code></a> instead
|
||
or create your own.</p>
|
||
<p>Note that the capacity of the <code>IndexMap</code> must be a power of 2.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<p>Since <code>IndexMap</code> cannot be used directly, we’re using its <code>FnvIndexMap</code> instantiation
|
||
for this example.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="comment">// A hash map with a capacity of 16 key-value pairs allocated on the stack
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>book_reviews = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
|
||
<span class="comment">// review some books.
|
||
</span>book_reviews.insert(<span class="string">"Adventures of Huckleberry Finn"</span>, <span class="string">"My favorite book."</span>).unwrap();
|
||
book_reviews.insert(<span class="string">"Grimms' Fairy Tales"</span>, <span class="string">"Masterpiece."</span>).unwrap();
|
||
book_reviews.insert(<span class="string">"Pride and Prejudice"</span>, <span class="string">"Very enjoyable."</span>).unwrap();
|
||
book_reviews.insert(<span class="string">"The Adventures of Sherlock Holmes"</span>, <span class="string">"Eye lyked it alot."</span>).unwrap();
|
||
|
||
<span class="comment">// check for a specific one.
|
||
</span><span class="kw">if </span>!book_reviews.contains_key(<span class="string">"Les Misérables"</span>) {
|
||
<span class="macro">println!</span>(<span class="string">"We've got {} reviews, but Les Misérables ain't one."</span>,
|
||
book_reviews.len());
|
||
}
|
||
|
||
<span class="comment">// oops, this review has a lot of spelling mistakes, let's delete it.
|
||
</span>book_reviews.remove(<span class="string">"The Adventures of Sherlock Holmes"</span>);
|
||
|
||
<span class="comment">// look up the values associated with some keys.
|
||
</span><span class="kw">let </span>to_find = [<span class="string">"Pride and Prejudice"</span>, <span class="string">"Alice's Adventure in Wonderland"</span>];
|
||
<span class="kw">for </span>book <span class="kw">in </span><span class="kw-2">&</span>to_find {
|
||
<span class="kw">match </span>book_reviews.get(book) {
|
||
<span class="prelude-val">Some</span>(review) => <span class="macro">println!</span>(<span class="string">"{}: {}"</span>, book, review),
|
||
<span class="prelude-val">None </span>=> <span class="macro">println!</span>(<span class="string">"{} is unreviewed."</span>, book)
|
||
}
|
||
}
|
||
|
||
<span class="comment">// iterate over everything.
|
||
</span><span class="kw">for </span>(book, review) <span class="kw">in </span><span class="kw-2">&</span>book_reviews {
|
||
<span class="macro">println!</span>(<span class="string">"{}: \"{}\""</span>, book, review);
|
||
}</code></pre></div>
|
||
</div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-IndexMap%3CK,+V,+BuildHasherDefault%3CS%3E,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#480">source</a><a href="#impl-IndexMap%3CK,+V,+BuildHasherDefault%3CS%3E,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, <a class="struct" href="../../hash32/struct.BuildHasherDefault.html" title="struct hash32::BuildHasherDefault">BuildHasherDefault</a><S>, N></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/heapless/indexmap.rs.html#482">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>() -> <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, <a class="struct" href="../../hash32/struct.BuildHasherDefault.html" title="struct hash32::BuildHasherDefault">BuildHasherDefault</a><S>, N></h4></section></summary><div class="docblock"><p>Creates an empty <code>IndexMap</code>.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#494">source</a><a href="#impl-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.capacity" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#501">source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Returns the number of elements the map can hold</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.keys" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#519">source</a><h4 class="code-header">pub fn <a href="#method.keys" class="fn">keys</a>(&self) -> impl Iterator<Item = &K></h4></section></summary><div class="docblock"><p>Return an iterator over the keys of the map, in their order</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
map.insert(<span class="string">"a"</span>, <span class="number">1</span>).unwrap();
|
||
map.insert(<span class="string">"b"</span>, <span class="number">2</span>).unwrap();
|
||
map.insert(<span class="string">"c"</span>, <span class="number">3</span>).unwrap();
|
||
|
||
<span class="kw">for </span>key <span class="kw">in </span>map.keys() {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, key);
|
||
}</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.values" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#537">source</a><h4 class="code-header">pub fn <a href="#method.values" class="fn">values</a>(&self) -> impl Iterator<Item = &V></h4></section></summary><div class="docblock"><p>Return an iterator over the values of the map, in their order</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
map.insert(<span class="string">"a"</span>, <span class="number">1</span>).unwrap();
|
||
map.insert(<span class="string">"b"</span>, <span class="number">2</span>).unwrap();
|
||
map.insert(<span class="string">"c"</span>, <span class="number">3</span>).unwrap();
|
||
|
||
<span class="kw">for </span>val <span class="kw">in </span>map.values() {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, val);
|
||
}</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/heapless/indexmap.rs.html#559">source</a><h4 class="code-header">pub fn <a href="#method.values_mut" class="fn">values_mut</a>(&mut self) -> impl Iterator<Item = &mut V></h4></section></summary><div class="docblock"><p>Return an iterator over mutable references to the the values of the map, in their order</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
map.insert(<span class="string">"a"</span>, <span class="number">1</span>).unwrap();
|
||
map.insert(<span class="string">"b"</span>, <span class="number">2</span>).unwrap();
|
||
map.insert(<span class="string">"c"</span>, <span class="number">3</span>).unwrap();
|
||
|
||
<span class="kw">for </span>val <span class="kw">in </span>map.values_mut() {
|
||
<span class="kw-2">*</span>val += <span class="number">10</span>;
|
||
}
|
||
|
||
<span class="kw">for </span>val <span class="kw">in </span>map.values() {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, val);
|
||
}</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.iter" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#577">source</a><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> Iter<'_, K, V></h4></section></summary><div class="docblock"><p>Return an iterator over the key-value pairs of the map, in their order</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
map.insert(<span class="string">"a"</span>, <span class="number">1</span>).unwrap();
|
||
map.insert(<span class="string">"b"</span>, <span class="number">2</span>).unwrap();
|
||
map.insert(<span class="string">"c"</span>, <span class="number">3</span>).unwrap();
|
||
|
||
<span class="kw">for </span>(key, val) <span class="kw">in </span>map.iter() {
|
||
<span class="macro">println!</span>(<span class="string">"key: {} val: {}"</span>, key, val);
|
||
}</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/heapless/indexmap.rs.html#601">source</a><h4 class="code-header">pub fn <a href="#method.iter_mut" class="fn">iter_mut</a>(&mut self) -> IterMut<'_, K, V></h4></section></summary><div class="docblock"><p>Return an iterator over the key-value pairs of the map, in their order</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
map.insert(<span class="string">"a"</span>, <span class="number">1</span>).unwrap();
|
||
map.insert(<span class="string">"b"</span>, <span class="number">2</span>).unwrap();
|
||
map.insert(<span class="string">"c"</span>, <span class="number">3</span>).unwrap();
|
||
|
||
<span class="kw">for </span>(<span class="kw">_</span>, val) <span class="kw">in </span>map.iter_mut() {
|
||
<span class="kw-2">*</span>val = <span class="number">2</span>;
|
||
}
|
||
|
||
<span class="kw">for </span>(key, val) <span class="kw">in </span><span class="kw-2">&</span>map {
|
||
<span class="macro">println!</span>(<span class="string">"key: {} val: {}"</span>, key, val);
|
||
}</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.first" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#610">source</a><h4 class="code-header">pub fn <a href="#method.first" class="fn">first</a>(&self) -> Option<(&K, &V)></h4></section></summary><div class="docblock"><p>Get the first key-value pair</p>
|
||
<p>Computes in <strong>O(1)</strong> time</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.first_mut" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#620">source</a><h4 class="code-header">pub fn <a href="#method.first_mut" class="fn">first_mut</a>(&mut self) -> Option<(&K, &mut V)></h4></section></summary><div class="docblock"><p>Get the first key-value pair, with mutable access to the value</p>
|
||
<p>Computes in <strong>O(1)</strong> time</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.last" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#630">source</a><h4 class="code-header">pub fn <a href="#method.last" class="fn">last</a>(&self) -> Option<(&K, &V)></h4></section></summary><div class="docblock"><p>Get the last key-value pair</p>
|
||
<p>Computes in <strong>O(1)</strong> time</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.last_mut" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#640">source</a><h4 class="code-header">pub fn <a href="#method.last_mut" class="fn">last_mut</a>(&mut self) -> Option<(&K, &mut V)></h4></section></summary><div class="docblock"><p>Get the last key-value pair, with mutable access to the value</p>
|
||
<p>Computes in <strong>O(1)</strong> time</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.entry" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#662">source</a><h4 class="code-header">pub fn <a href="#method.entry" class="fn">entry</a>(&mut self, key: K) -> <a class="enum" href="enum.Entry.html" title="enum arduboy_rust::heapless::Entry">Entry</a><'_, K, V, N></h4></section></summary><div class="docblock"><p>Returns an entry for the corresponding key</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
<span class="kw">use </span>heapless::Entry;
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
<span class="kw">if let </span>Entry::Vacant(v) = map.entry(<span class="string">"a"</span>) {
|
||
v.insert(<span class="number">1</span>).unwrap();
|
||
}
|
||
<span class="kw">if let </span>Entry::Occupied(<span class="kw-2">mut </span>o) = map.entry(<span class="string">"a"</span>) {
|
||
<span class="macro">println!</span>(<span class="string">"found {}"</span>, <span class="kw-2">*</span>o.get()); <span class="comment">// Prints 1
|
||
</span>o.insert(<span class="number">2</span>);
|
||
}
|
||
<span class="comment">// Prints 2
|
||
</span><span class="macro">println!</span>(<span class="string">"val: {}"</span>, <span class="kw-2">*</span>map.get(<span class="string">"a"</span>).unwrap());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.len" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#692">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&self) -> usize</h4></section></summary><div class="docblock"><p>Return the number of key-value pairs in the map.</p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
<span class="macro">assert_eq!</span>(a.len(), <span class="number">0</span>);
|
||
a.insert(<span class="number">1</span>, <span class="string">"a"</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(a.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/heapless/indexmap.rs.html#708">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&self) -> bool</h4></section></summary><div class="docblock"><p>Returns true if the map contains no elements.</p>
|
||
<p>Computes in <strong>O(1)</strong> time.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
<span class="macro">assert!</span>(a.is_empty());
|
||
a.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
<span class="macro">assert!</span>(!a.is_empty());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#724">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>Remove all key-value pairs in the map, while preserving its capacity.</p>
|
||
<p>Computes in <strong>O(n)</strong> time.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
a.insert(<span class="number">1</span>, <span class="string">"a"</span>);
|
||
a.clear();
|
||
<span class="macro">assert!</span>(a.is_empty());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.get" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#746-749">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a><Q>(&self, key: &Q) -> Option<&V><span class="where fmt-newline">where
|
||
K: Borrow<Q>,
|
||
Q: <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + Eq + ?Sized,</span></h4></section></summary><div class="docblock"><p>Returns a reference to the value corresponding to the key.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but <code>Hash</code> and <code>Eq</code> on the borrowed
|
||
form <em>must</em> match those for the key type.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(map.get(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="string">"a"</span>));
|
||
<span class="macro">assert_eq!</span>(map.get(<span class="kw-2">&</span><span class="number">2</span>), <span class="prelude-val">None</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/heapless/indexmap.rs.html#772-775">source</a><h4 class="code-header">pub fn <a href="#method.contains_key" class="fn">contains_key</a><Q>(&self, key: &Q) -> bool<span class="where fmt-newline">where
|
||
K: Borrow<Q>,
|
||
Q: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + ?Sized,</span></h4></section></summary><div class="docblock"><p>Returns true if the map contains a value for the specified key.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but <code>Hash</code> and <code>Eq</code> on the borrowed
|
||
form <em>must</em> match those for the key type.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
<h5 id="examples-1"><a href="#examples-1">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">8</span>>::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(map.contains_key(<span class="kw-2">&</span><span class="number">1</span>), <span class="bool-val">true</span>);
|
||
<span class="macro">assert_eq!</span>(map.contains_key(<span class="kw-2">&</span><span class="number">2</span>), <span class="bool-val">false</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/heapless/indexmap.rs.html#799-802">source</a><h4 class="code-header">pub fn <a href="#method.get_mut" class="fn">get_mut</a><Q, 'v>(&'v mut self, key: &Q) -> Option<&'v mut V><span class="where fmt-newline">where
|
||
K: Borrow<Q>,
|
||
Q: <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + Eq + ?Sized,</span></h4></section></summary><div class="docblock"><p>Returns a mutable reference to the value corresponding to the key.</p>
|
||
<p>The key may be any borrowed form of the map’s key type, but <code>Hash</code> and <code>Eq</code> on the borrowed
|
||
form <em>must</em> match those for the key type.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
<h5 id="examples-2"><a href="#examples-2">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">8</span>>::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>).unwrap();
|
||
<span class="kw">if let </span><span class="prelude-val">Some</span>(x) = map.get_mut(<span class="kw-2">&</span><span class="number">1</span>) {
|
||
<span class="kw-2">*</span>x = <span class="string">"b"</span>;
|
||
}
|
||
<span class="macro">assert_eq!</span>(map[<span class="kw-2">&</span><span class="number">1</span>], <span class="string">"b"</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/heapless/indexmap.rs.html#838">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(&mut self, key: K, value: V) -> Result<Option<V>, (K, V)></h4></section></summary><div class="docblock"><p>Inserts a key-value pair into the map.</p>
|
||
<p>If an equivalent key already exists in the map: the key remains and retains in its place in
|
||
the order, its corresponding value is updated with <code>value</code> and the older value is returned
|
||
inside <code>Some(_)</code>.</p>
|
||
<p>If no equivalent key existed in the map: the new key-value pair is inserted, last in order,
|
||
and <code>None</code> is returned.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
<p>See also entry if you you want to insert or modify or if you need to get the index of the
|
||
corresponding key-value pair.</p>
|
||
<h5 id="examples-3"><a href="#examples-3">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">8</span>>::new();
|
||
<span class="macro">assert_eq!</span>(map.insert(<span class="number">37</span>, <span class="string">"a"</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">None</span>));
|
||
<span class="macro">assert_eq!</span>(map.is_empty(), <span class="bool-val">false</span>);
|
||
|
||
map.insert(<span class="number">37</span>, <span class="string">"b"</span>);
|
||
<span class="macro">assert_eq!</span>(map.insert(<span class="number">37</span>, <span class="string">"c"</span>), <span class="prelude-val">Ok</span>(<span class="prelude-val">Some</span>(<span class="string">"b"</span>)));
|
||
<span class="macro">assert_eq!</span>(map[<span class="kw-2">&</span><span class="number">37</span>], <span class="string">"c"</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.remove" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#860-863">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a><Q>(&mut self, key: &Q) -> Option<V><span class="where fmt-newline">where
|
||
K: Borrow<Q>,
|
||
Q: <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + Eq + ?Sized,</span></h4></section></summary><div class="docblock"><p>Same as <a href="struct.IndexMap.html#method.swap_remove"><code>swap_remove</code></a></p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
<h5 id="examples-4"><a href="#examples-4">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexMap;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>map = FnvIndexMap::<<span class="kw">_</span>, <span class="kw">_</span>, <span class="number">8</span>>::new();
|
||
map.insert(<span class="number">1</span>, <span class="string">"a"</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(map.remove(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">Some</span>(<span class="string">"a"</span>));
|
||
<span class="macro">assert_eq!</span>(map.remove(<span class="kw-2">&</span><span class="number">1</span>), <span class="prelude-val">None</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.swap_remove" class="method"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#876-879">source</a><h4 class="code-header">pub fn <a href="#method.swap_remove" class="fn">swap_remove</a><Q>(&mut self, key: &Q) -> Option<V><span class="where fmt-newline">where
|
||
K: Borrow<Q>,
|
||
Q: <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + Eq + ?Sized,</span></h4></section></summary><div class="docblock"><p>Remove the key-value pair equivalent to <code>key</code> and return its value.</p>
|
||
<p>Like <code>Vec::swap_remove</code>, the pair is removed by swapping it with the last element of the map
|
||
and popping it off. <strong>This perturbs the postion of what used to be the last element!</strong></p>
|
||
<p>Return <code>None</code> if <code>key</code> is not in map.</p>
|
||
<p>Computes in <strong>O(1)</strong> time (average).</p>
|
||
</div></details></div></details></div><h2 id="trait-implementations" class="small-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-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#924">source</a><a href="#impl-Clone-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> Clone for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + Clone,
|
||
V: Clone,
|
||
S: Clone,</span></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/heapless/indexmap.rs.html#930">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a class="fn">clone</a>(&self) -> <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N></h4></section></summary><div class='docblock'>Returns a copy of the value. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a class="fn">clone_from</a>(&mut self, source: &Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#938">source</a><a href="#impl-Debug-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> Debug for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + Debug,
|
||
V: Debug,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></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/heapless/indexmap.rs.html#944">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a class="fn">fmt</a>(&self, f: &mut Formatter<'_>) -> Result<(), Error></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#949">source</a><a href="#impl-Default-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> Default for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a> + Default,</span></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/heapless/indexmap.rs.html#954">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a class="fn">default</a>() -> <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N></h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Extend%3C(%26'a+K,+%26'a+V)%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#1005">source</a><a href="#impl-Extend%3C(%26'a+K,+%26'a+V)%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, S, const N: usize> Extend<(&'a K, &'a V)> for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + Copy,
|
||
V: Copy,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.extend" class="method trait-impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#1011-1013">source</a><a href="#method.extend" class="anchor">§</a><h4 class="code-header">fn <a class="fn">extend</a><I>(&mut self, iterable: I)<span class="where fmt-newline">where
|
||
I: IntoIterator<Item = (&'a K, &'a V)>,</span></h4></section></summary><div class='docblock'>Extends a collection with the contents of an iterator. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.extend_one" class="method trait-impl"><a href="#method.extend_one" class="anchor">§</a><h4 class="code-header">fn <a class="fn">extend_one</a>(&mut self, item: 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>extend_one</code>)</span></div></span><div class='docblock'>Extends a collection with exactly one element.</div></details><details class="toggle method-toggle" open><summary><section id="method.extend_reserve" class="method trait-impl"><a href="#method.extend_reserve" class="anchor">§</a><h4 class="code-header">fn <a class="fn">extend_reserve</a>(&mut self, additional: usize)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>extend_one</code>)</span></div></span><div class='docblock'>Reserves capacity in a collection for the given number of additional elements. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Extend%3C(K,+V)%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#990">source</a><a href="#impl-Extend%3C(K,+V)%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> Extend<(K, V)> for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.extend-1" class="method trait-impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#995-997">source</a><a href="#method.extend-1" class="anchor">§</a><h4 class="code-header">fn <a class="fn">extend</a><I>(&mut self, iterable: I)<span class="where fmt-newline">where
|
||
I: IntoIterator<Item = (K, V)>,</span></h4></section></summary><div class='docblock'>Extends a collection with the contents of an iterator. <a>Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.extend_one-1" class="method trait-impl"><a href="#method.extend_one-1" class="anchor">§</a><h4 class="code-header">fn <a class="fn">extend_one</a>(&mut self, item: 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>extend_one</code>)</span></div></span><div class='docblock'>Extends a collection with exactly one element.</div></details><details class="toggle method-toggle" open><summary><section id="method.extend_reserve-1" class="method trait-impl"><a href="#method.extend_reserve-1" class="anchor">§</a><h4 class="code-header">fn <a class="fn">extend_reserve</a>(&mut self, additional: usize)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>extend_one</code>)</span></div></span><div class='docblock'>Reserves capacity in a collection for the given number of additional elements. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-FromIterator%3C(K,+V)%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#1019">source</a><a href="#impl-FromIterator%3C(K,+V)%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> FromIterator<(K, V)> for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a> + Default,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from_iter" class="method trait-impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#1024-1026">source</a><a href="#method.from_iter" class="anchor">§</a><h4 class="code-header">fn <a class="fn">from_iter</a><I>(iterable: I) -> <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
I: IntoIterator<Item = (K, V)>,</span></h4></section></summary><div class='docblock'>Creates a value from an iterator. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Index%3C%26'a+Q%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#900">source</a><a href="#impl-Index%3C%26'a+Q%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, Q, V, S, const N: usize> Index<&'a Q> for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + Borrow<Q>,
|
||
Q: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + ?Sized,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a 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/heapless/indexmap.rs.html#908">source</a><a href="#method.index" class="anchor">§</a><h4 class="code-header">fn <a class="fn">index</a>(&self, key: &Q) -> &V</h4></section></summary><div class='docblock'>Performs the indexing (<code>container[index]</code>) operation. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IndexMut%3C%26'a+Q%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#913">source</a><a href="#impl-IndexMut%3C%26'a+Q%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, Q, V, S, const N: usize> IndexMut<&'a Q> for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + Borrow<Q>,
|
||
Q: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + ?Sized,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></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/heapless/indexmap.rs.html#919">source</a><a href="#method.index_mut" class="anchor">§</a><h4 class="code-header">fn <a class="fn">index_mut</a>(&mut self, key: &Q) -> &mut V</h4></section></summary><div class='docblock'>Performs the mutable indexing (<code>container[index]</code>) operation. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26'a+IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#1062">source</a><a href="#impl-IntoIterator-for-%26'a+IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, S, const N: usize> IntoIterator for &'a <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Item</a> = (&'a K, &'a V)</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 href="#associatedtype.IntoIter" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">IntoIter</a> = Iter<'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/heapless/indexmap.rs.html#1070">source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_iter</a>(self) -> <&'a <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N> as IntoIterator>::IntoIter</h4></section></summary><div class='docblock'>Creates an iterator from a value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26'a+mut+IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#1075">source</a><a href="#impl-IntoIterator-for-%26'a+mut+IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, K, V, S, const N: usize> IntoIterator for &'a mut <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-2" class="associatedtype trait-impl"><a href="#associatedtype.Item-2" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Item</a> = (&'a K, &'a mut V)</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 href="#associatedtype.IntoIter-2" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">IntoIter</a> = IterMut<'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/heapless/indexmap.rs.html#1083">source</a><a href="#method.into_iter-2" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_iter</a>(self) -> <&'a mut <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N> as IntoIterator>::IntoIter</h4></section></summary><div class='docblock'>Creates an iterator from a value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#1047">source</a><a href="#impl-IntoIterator-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> IntoIterator for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Item</a> = (K, V)</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 href="#associatedtype.IntoIter-1" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">IntoIter</a> = IntoIter<K, V, N></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/heapless/indexmap.rs.html#1055">source</a><a href="#method.into_iter-1" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_iter</a>(self) -> <<a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N> as IntoIterator>::IntoIter</h4></section></summary><div class='docblock'>Creates an iterator from a value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq%3CIndexMap%3CK,+V,+S2,+N2%3E%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#966-967">source</a><a href="#impl-PartialEq%3CIndexMap%3CK,+V,+S2,+N2%3E%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, S2, const N: usize, const N2: usize> PartialEq<<a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S2, N2>> for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
V: Eq,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,
|
||
S2: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.eq" class="method trait-impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#974">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a class="fn">eq</a>(&self, other: &<a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S2, N2>) -> bool</h4></section></summary><div class='docblock'>This method tests for <code>self</code> and <code>other</code> values to be equal, and is used
|
||
by <code>==</code>.</div></details><details class="toggle method-toggle" open><summary><section id="method.ne" class="method trait-impl"><span class="since rightside" title="Stable since Rust version 1.0.0">1.0.0</span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a class="fn">ne</a>(&self, other: &Rhs) -> bool</h4></section></summary><div class='docblock'>This method tests for <code>!=</code>. The default implementation is almost always
|
||
sufficient, and should not be overridden without very good reason.</div></details></div></details><section id="impl-Eq-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a class="src rightside" href="../../src/heapless/indexmap.rs.html#982">source</a><a href="#impl-Eq-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> Eq for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Eq + <a class="trait" href="../../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
V: Eq,
|
||
S: <a class="trait" href="../../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h3></section></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-RefUnwindSafe-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> RefUnwindSafe for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: RefUnwindSafe,
|
||
S: RefUnwindSafe,
|
||
V: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-Send-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> Send for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Send,
|
||
S: Send,
|
||
V: Send,</span></h3></section><section id="impl-Sync-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-Sync-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> Sync for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Sync,
|
||
S: Sync,
|
||
V: Sync,</span></h3></section><section id="impl-Unpin-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-Unpin-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> Unpin for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: Unpin,
|
||
S: Unpin,
|
||
V: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-UnwindSafe-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<K, V, S, const N: usize> UnwindSafe for <a class="struct" href="struct.IndexMap.html" title="struct arduboy_rust::heapless::IndexMap">IndexMap</a><K, V, S, N><span class="where fmt-newline">where
|
||
K: UnwindSafe,
|
||
S: UnwindSafe,
|
||
V: UnwindSafe,</span></h3></section></div><h2 id="blanket-implementations" class="small-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-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-Any-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where
|
||
T: 'static + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a class="fn">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-Borrow%3CT%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where
|
||
T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a class="fn">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-BorrowMut%3CT%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where
|
||
T: ?Sized,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a class="fn">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-From%3CT%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T> From<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 href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a 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-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-Into%3CU%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where
|
||
U: From<T>,</span></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a 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>[From]<T> for U</code> chooses to do.</p>
|
||
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-TryFrom%3CU%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where
|
||
U: Into<T>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = Infallible</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 href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></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-IndexMap%3CK,+V,+S,+N%3E" class="impl"><a href="#impl-TryInto%3CU%3E-for-IndexMap%3CK,+V,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where
|
||
U: TryFrom<T>,</span></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</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 href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a class="fn">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main></body></html> |