296 lines
No EOL
58 KiB
HTML
296 lines
No EOL
58 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 `IndexSet`."><title>IndexSet in 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-fa3bb1812debf86c.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="heapless" data-themes="" data-resource-suffix="" data-rustdoc-version="1.75.0-nightly (2bbb61989 2023-10-04)" data-channel="nightly" data-search-js="search-8be46b629f5f14a8.js" data-settings-js="settings-74424d7eec62a23e.js" ><script src="../static.files/storage-fec3eaa3851e447d.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-c5bd66d33317d69f.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-5d8b3c7633ad77ba.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="../heapless/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a></nav><nav class="sidebar"><a class="logo-container" href="../heapless/index.html"><img class="rust-logo" src="../static.files/rust-logo-151179464ae7ed46.svg" alt="logo"></a><h2 class="location"><a href="#">IndexSet</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">contains</a></li><li><a href="#method.difference">difference</a></li><li><a href="#method.first">first</a></li><li><a href="#method.insert">insert</a></li><li><a href="#method.intersection">intersection</a></li><li><a href="#method.is_disjoint">is_disjoint</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.is_subset">is_subset</a></li><li><a href="#method.is_superset">is_superset</a></li><li><a href="#method.iter">iter</a></li><li><a href="#method.last">last</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.symmetric_difference">symmetric_difference</a></li><li><a href="#method.union">union</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Clone-for-IndexSet%3CT,+S,+N%3E">Clone</a></li><li><a href="#impl-Debug-for-IndexSet%3CT,+S,+N%3E">Debug</a></li><li><a href="#impl-Default-for-IndexSet%3CT,+S,+N%3E">Default</a></li><li><a href="#impl-Extend%3C%26'a+T%3E-for-IndexSet%3CT,+S,+N%3E">Extend<&'a T></a></li><li><a href="#impl-Extend%3CT%3E-for-IndexSet%3CT,+S,+N%3E">Extend<T></a></li><li><a href="#impl-FromIterator%3CT%3E-for-IndexSet%3CT,+S,+N%3E">FromIterator<T></a></li><li><a href="#impl-IntoIterator-for-%26'a+IndexSet%3CT,+S,+N%3E">IntoIterator</a></li><li><a href="#impl-PartialEq%3CIndexSet%3CT,+S2,+N2%3E%3E-for-IndexSet%3CT,+S1,+N1%3E">PartialEq<IndexSet<T, S2, N2>></a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-IndexSet%3CT,+S,+N%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-IndexSet%3CT,+S,+N%3E">Send</a></li><li><a href="#impl-Sync-for-IndexSet%3CT,+S,+N%3E">Sync</a></li><li><a href="#impl-Unpin-for-IndexSet%3CT,+S,+N%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-IndexSet%3CT,+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-IndexSet%3CT,+S,+N%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-IndexSet%3CT,+S,+N%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-IndexSet%3CT,+S,+N%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-IndexSet%3CT,+S,+N%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-IndexSet%3CT,+S,+N%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-IndexSet%3CT,+S,+N%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-IndexSet%3CT,+S,+N%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In 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">heapless</a>::<wbr><a class="struct" href="#">IndexSet</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/indexset.rs.html#77-79">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub struct IndexSet<T, 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/set/struct.IndexSet.html"><code>IndexSet</code></a>.</p>
|
||
<p>Note that you cannot use <code>IndexSet</code> directly, since it is generic around the hashing algorithm
|
||
in use. Pick a concrete instantiation like <a href="./type.FnvIndexSet.html"><code>FnvIndexSet</code></a> instead
|
||
or create your own.</p>
|
||
<p>Note that the capacity of the <code>IndexSet</code> must be a power of 2.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<p>Since <code>IndexSet</code> cannot be used directly, we’re using its <code>FnvIndexSet</code> instantiation
|
||
for this example.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="comment">// A hash set with a capacity of 16 elements allocated on the stack
|
||
</span><span class="kw">let </span><span class="kw-2">mut </span>books = FnvIndexSet::<<span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
|
||
<span class="comment">// Add some books.
|
||
</span>books.insert(<span class="string">"A Dance With Dragons"</span>).unwrap();
|
||
books.insert(<span class="string">"To Kill a Mockingbird"</span>).unwrap();
|
||
books.insert(<span class="string">"The Odyssey"</span>).unwrap();
|
||
books.insert(<span class="string">"The Great Gatsby"</span>).unwrap();
|
||
|
||
<span class="comment">// Check for a specific one.
|
||
</span><span class="kw">if </span>!books.contains(<span class="string">"The Winds of Winter"</span>) {
|
||
<span class="macro">println!</span>(<span class="string">"We have {} books, but The Winds of Winter ain't one."</span>,
|
||
books.len());
|
||
}
|
||
|
||
<span class="comment">// Remove a book.
|
||
</span>books.remove(<span class="string">"The Odyssey"</span>);
|
||
|
||
<span class="comment">// Iterate over everything.
|
||
</span><span class="kw">for </span>book <span class="kw">in </span><span class="kw-2">&</span>books {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, book);
|
||
}</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-IndexSet%3CT,+BuildHasherDefault%3CS%3E,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#81-88">source</a><a href="#impl-IndexSet%3CT,+BuildHasherDefault%3CS%3E,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, <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/indexset.rs.html#83-87">source</a><h4 class="code-header">pub const fn <a href="#method.new" class="fn">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Creates an empty <code>IndexSet</code></p>
|
||
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IndexSet%3CT,+S,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#90-467">source</a><a href="#impl-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
T: 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/indexset.rs.html#105-107">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 set can hold</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::FnvIndexSet;
|
||
|
||
<span class="kw">let </span>set = FnvIndexSet::<i32, <span class="number">16</span>>::new();
|
||
<span class="macro">assert_eq!</span>(set.capacity(), <span class="number">16</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/heapless/indexset.rs.html#125-129">source</a><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&self) -> Iter<'_, T></h4></section></summary><div class="docblock"><p>Return an iterator over the values of the set, in their order</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::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>set = FnvIndexSet::<<span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
set.insert(<span class="string">"a"</span>).unwrap();
|
||
set.insert(<span class="string">"b"</span>).unwrap();
|
||
|
||
<span class="comment">// Will print in an arbitrary order.
|
||
</span><span class="kw">for </span>x <span class="kw">in </span>set.iter() {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
|
||
}</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/indexset.rs.html#134-136">source</a><h4 class="code-header">pub fn <a href="#method.first" class="fn">first</a>(&self) -> Option<&T></h4></section></summary><div class="docblock"><p>Get the first 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/indexset.rs.html#141-143">source</a><h4 class="code-header">pub fn <a href="#method.last" class="fn">last</a>(&self) -> Option<&T></h4></section></summary><div class="docblock"><p>Get the last value</p>
|
||
<p>Computes in <strong>O(1)</strong> time</p>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.difference" class="method"><a class="src rightside" href="../src/heapless/indexset.rs.html#169-180">source</a><h4 class="code-header">pub fn <a href="#method.difference" class="fn">difference</a><'a, S2, const N2: usize>(
|
||
&'a self,
|
||
other: &'a <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S2, N2>
|
||
) -> Difference<'a, T, S2, N2><span class="where fmt-newline">where
|
||
S2: <a class="trait" href="../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h4></section></summary><div class="docblock"><p>Visits the values representing the difference, i.e. the values that are in <code>self</code> but not in
|
||
<code>other</code>.</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::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].iter().cloned().collect();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>b: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].iter().cloned().collect();
|
||
|
||
<span class="comment">// Can be seen as `a - b`.
|
||
</span><span class="kw">for </span>x <span class="kw">in </span>a.difference(<span class="kw-2">&</span>b) {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, x); <span class="comment">// Print 1
|
||
</span>}
|
||
|
||
<span class="kw">let </span>diff: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = a.difference(<span class="kw-2">&</span>b).collect();
|
||
<span class="macro">assert_eq!</span>(diff, [<span class="number">1</span>].iter().collect::<FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>>>());
|
||
|
||
<span class="comment">// Note that difference is not symmetric,
|
||
// and `b - a` means something else:
|
||
</span><span class="kw">let </span>diff: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = b.difference(<span class="kw-2">&</span>a).collect();
|
||
<span class="macro">assert_eq!</span>(diff, [<span class="number">4</span>].iter().collect::<FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>>>());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.symmetric_difference" class="method"><a class="src rightside" href="../src/heapless/indexset.rs.html#204-212">source</a><h4 class="code-header">pub fn <a href="#method.symmetric_difference" class="fn">symmetric_difference</a><'a, S2, const N2: usize>(
|
||
&'a self,
|
||
other: &'a <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S2, N2>
|
||
) -> impl Iterator<Item = &'a T><span class="where fmt-newline">where
|
||
S2: <a class="trait" href="../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h4></section></summary><div class="docblock"><p>Visits the values representing the symmetric difference, i.e. the values that are in <code>self</code>
|
||
or in <code>other</code> but not in both.</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::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].iter().cloned().collect();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>b: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].iter().cloned().collect();
|
||
|
||
<span class="comment">// Print 1, 4 in that order order.
|
||
</span><span class="kw">for </span>x <span class="kw">in </span>a.symmetric_difference(<span class="kw-2">&</span>b) {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
|
||
}
|
||
|
||
<span class="kw">let </span>diff1: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = a.symmetric_difference(<span class="kw-2">&</span>b).collect();
|
||
<span class="kw">let </span>diff2: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = b.symmetric_difference(<span class="kw-2">&</span>a).collect();
|
||
|
||
<span class="macro">assert_eq!</span>(diff1, diff2);
|
||
<span class="macro">assert_eq!</span>(diff1, [<span class="number">1</span>, <span class="number">4</span>].iter().collect::<FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>>>());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.intersection" class="method"><a class="src rightside" href="../src/heapless/indexset.rs.html#233-244">source</a><h4 class="code-header">pub fn <a href="#method.intersection" class="fn">intersection</a><'a, S2, const N2: usize>(
|
||
&'a self,
|
||
other: &'a <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S2, N2>
|
||
) -> Intersection<'a, T, S2, N2><span class="where fmt-newline">where
|
||
S2: <a class="trait" href="../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h4></section></summary><div class="docblock"><p>Visits the values representing the intersection, i.e. the values that are both in <code>self</code> and
|
||
<code>other</code>.</p>
|
||
<h5 id="examples-5"><a href="#examples-5">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].iter().cloned().collect();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>b: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].iter().cloned().collect();
|
||
|
||
<span class="comment">// Print 2, 3 in that order.
|
||
</span><span class="kw">for </span>x <span class="kw">in </span>a.intersection(<span class="kw-2">&</span>b) {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
|
||
}
|
||
|
||
<span class="kw">let </span>intersection: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = a.intersection(<span class="kw-2">&</span>b).collect();
|
||
<span class="macro">assert_eq!</span>(intersection, [<span class="number">2</span>, <span class="number">3</span>].iter().collect::<FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>>>());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.union" class="method"><a class="src rightside" href="../src/heapless/indexset.rs.html#265-273">source</a><h4 class="code-header">pub fn <a href="#method.union" class="fn">union</a><'a, S2, const N2: usize>(
|
||
&'a self,
|
||
other: &'a <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S2, N2>
|
||
) -> impl Iterator<Item = &'a T><span class="where fmt-newline">where
|
||
S2: <a class="trait" href="../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h4></section></summary><div class="docblock"><p>Visits the values representing the union, i.e. all the values in <code>self</code> or <code>other</code>, without
|
||
duplicates.</p>
|
||
<h5 id="examples-6"><a href="#examples-6">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>a: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].iter().cloned().collect();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>b: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].iter().cloned().collect();
|
||
|
||
<span class="comment">// Print 1, 2, 3, 4 in that order.
|
||
</span><span class="kw">for </span>x <span class="kw">in </span>a.union(<span class="kw-2">&</span>b) {
|
||
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
|
||
}
|
||
|
||
<span class="kw">let union</span>: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = a.union(<span class="kw-2">&</span>b).collect();
|
||
<span class="macro">assert_eq!</span>(union, [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].iter().collect::<FnvIndexSet<<span class="kw">_</span>, <span class="number">16</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/heapless/indexset.rs.html#287-289">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>Returns the number of elements in the set.</p>
|
||
<h5 id="examples-7"><a href="#examples-7">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>v: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = FnvIndexSet::new();
|
||
<span class="macro">assert_eq!</span>(v.len(), <span class="number">0</span>);
|
||
v.insert(<span class="number">1</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(v.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/indexset.rs.html#303-305">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 <code>true</code> if the set contains no elements.</p>
|
||
<h5 id="examples-8"><a href="#examples-8">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>v: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = FnvIndexSet::new();
|
||
<span class="macro">assert!</span>(v.is_empty());
|
||
v.insert(<span class="number">1</span>).unwrap();
|
||
<span class="macro">assert!</span>(!v.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/indexset.rs.html#319-321">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 set, removing all values.</p>
|
||
<h5 id="examples-9"><a href="#examples-9">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>v: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = FnvIndexSet::new();
|
||
v.insert(<span class="number">1</span>).unwrap();
|
||
v.clear();
|
||
<span class="macro">assert!</span>(v.is_empty());</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.contains" class="method"><a class="src rightside" href="../src/heapless/indexset.rs.html#337-343">source</a><h4 class="code-header">pub fn <a href="#method.contains" class="fn">contains</a><Q>(&self, value: &Q) -> bool<span class="where fmt-newline">where
|
||
T: Borrow<Q>,
|
||
Q: ?Sized + Eq + <a class="trait" href="../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,</span></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the set contains a value.</p>
|
||
<p>The value may be any borrowed form of the set’s value type, but <code>Hash</code> and <code>Eq</code> on the
|
||
borrowed form must match those for the value type.</p>
|
||
<h5 id="examples-10"><a href="#examples-10">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span>set: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].iter().cloned().collect();
|
||
<span class="macro">assert_eq!</span>(set.contains(<span class="kw-2">&</span><span class="number">1</span>), <span class="bool-val">true</span>);
|
||
<span class="macro">assert_eq!</span>(set.contains(<span class="kw-2">&</span><span class="number">4</span>), <span class="bool-val">false</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_disjoint" class="method"><a class="src rightside" href="../src/heapless/indexset.rs.html#362-367">source</a><h4 class="code-header">pub fn <a href="#method.is_disjoint" class="fn">is_disjoint</a><S2, const N2: usize>(
|
||
&self,
|
||
other: &<a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S2, N2>
|
||
) -> bool<span class="where fmt-newline">where
|
||
S2: <a class="trait" href="../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if <code>self</code> has no elements in common with <code>other</code>. This is equivalent to
|
||
checking for an empty intersection.</p>
|
||
<h5 id="examples-11"><a href="#examples-11">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span>a: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].iter().cloned().collect();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>b = FnvIndexSet::<<span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
|
||
<span class="macro">assert_eq!</span>(a.is_disjoint(<span class="kw-2">&</span>b), <span class="bool-val">true</span>);
|
||
b.insert(<span class="number">4</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(a.is_disjoint(<span class="kw-2">&</span>b), <span class="bool-val">true</span>);
|
||
b.insert(<span class="number">1</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(a.is_disjoint(<span class="kw-2">&</span>b), <span class="bool-val">false</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_subset" class="method"><a class="src rightside" href="../src/heapless/indexset.rs.html#386-391">source</a><h4 class="code-header">pub fn <a href="#method.is_subset" class="fn">is_subset</a><S2, const N2: usize>(
|
||
&self,
|
||
other: &<a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S2, N2>
|
||
) -> bool<span class="where fmt-newline">where
|
||
S2: <a class="trait" href="../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the set is a subset of another, i.e. <code>other</code> contains at least all the
|
||
values in <code>self</code>.</p>
|
||
<h5 id="examples-12"><a href="#examples-12">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span>sup: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].iter().cloned().collect();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>set = FnvIndexSet::<<span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
|
||
<span class="macro">assert_eq!</span>(set.is_subset(<span class="kw-2">&</span>sup), <span class="bool-val">true</span>);
|
||
set.insert(<span class="number">2</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(set.is_subset(<span class="kw-2">&</span>sup), <span class="bool-val">true</span>);
|
||
set.insert(<span class="number">4</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(set.is_subset(<span class="kw-2">&</span>sup), <span class="bool-val">false</span>);</code></pre></div>
|
||
</div></details><details class="toggle method-toggle" open><summary><section id="method.is_superset" class="method"><a class="src rightside" href="../src/heapless/indexset.rs.html#413-418">source</a><h4 class="code-header">pub fn <a href="#method.is_superset" class="fn">is_superset</a><S2, const N2: usize>(
|
||
&self,
|
||
other: &<a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S2, N2>
|
||
) -> bool<span class="where fmt-newline">where
|
||
S2: <a class="trait" href="../hash32/trait.BuildHasher.html" title="trait hash32::BuildHasher">BuildHasher</a>,</span></h4></section></summary><div class="docblock"><h5 id="examples-13"><a href="#examples-13">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span>sub: FnvIndexSet<<span class="kw">_</span>, <span class="number">16</span>> = [<span class="number">1</span>, <span class="number">2</span>].iter().cloned().collect();
|
||
<span class="kw">let </span><span class="kw-2">mut </span>set = FnvIndexSet::<<span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
|
||
<span class="macro">assert_eq!</span>(set.is_superset(<span class="kw-2">&</span>sub), <span class="bool-val">false</span>);
|
||
|
||
set.insert(<span class="number">0</span>).unwrap();
|
||
set.insert(<span class="number">1</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(set.is_superset(<span class="kw-2">&</span>sub), <span class="bool-val">false</span>);
|
||
|
||
set.insert(<span class="number">2</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(set.is_superset(<span class="kw-2">&</span>sub), <span class="bool-val">true</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/indexset.rs.html#437-442">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(&mut self, value: T) -> Result<bool, T></h4></section></summary><div class="docblock"><p>Adds a value to the set.</p>
|
||
<p>If the set did not have this value present, <code>true</code> is returned.</p>
|
||
<p>If the set did have this value present, <code>false</code> is returned.</p>
|
||
<h5 id="examples-14"><a href="#examples-14">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>set = FnvIndexSet::<<span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
|
||
<span class="macro">assert_eq!</span>(set.insert(<span class="number">2</span>).unwrap(), <span class="bool-val">true</span>);
|
||
<span class="macro">assert_eq!</span>(set.insert(<span class="number">2</span>).unwrap(), <span class="bool-val">false</span>);
|
||
<span class="macro">assert_eq!</span>(set.len(), <span class="number">1</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/indexset.rs.html#460-466">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a><Q>(&mut self, value: &Q) -> bool<span class="where fmt-newline">where
|
||
T: Borrow<Q>,
|
||
Q: ?Sized + Eq + <a class="trait" href="../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,</span></h4></section></summary><div class="docblock"><p>Removes a value from the set. Returns <code>true</code> if the value was present in the set.</p>
|
||
<p>The value may be any borrowed form of the set’s value type, but <code>Hash</code> and <code>Eq</code> on the
|
||
borrowed form must match those for the value type.</p>
|
||
<h5 id="examples-15"><a href="#examples-15">Examples</a></h5>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>heapless::FnvIndexSet;
|
||
|
||
<span class="kw">let </span><span class="kw-2">mut </span>set = FnvIndexSet::<<span class="kw">_</span>, <span class="number">16</span>>::new();
|
||
|
||
set.insert(<span class="number">2</span>).unwrap();
|
||
<span class="macro">assert_eq!</span>(set.remove(<span class="kw-2">&</span><span class="number">2</span>), <span class="bool-val">true</span>);
|
||
<span class="macro">assert_eq!</span>(set.remove(<span class="kw-2">&</span><span class="number">2</span>), <span class="bool-val">false</span>);</code></pre></div>
|
||
</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-IndexSet%3CT,+S,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#469-479">source</a><a href="#impl-Clone-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> Clone for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
T: Eq + <a class="trait" href="../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + 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/indexset.rs.html#474-478">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a class="fn">clone</a>(&self) -> Self</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-IndexSet%3CT,+S,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#481-489">source</a><a href="#impl-Debug-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> Debug for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
T: Eq + <a class="trait" href="../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + 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/indexset.rs.html#486-488">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a class="fn">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</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-IndexSet%3CT,+S,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#491-501">source</a><a href="#impl-Default-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> Default for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
T: 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/indexset.rs.html#496-500">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a class="fn">default</a>() -> Self</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+T%3E-for-IndexSet%3CT,+S,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#528-539">source</a><a href="#impl-Extend%3C%26'a+T%3E-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, S, const N: usize> Extend<&'a T> for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
T: 'a + Eq + <a class="trait" href="../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a> + 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-1" class="method trait-impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#533-538">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 = &'a T>,</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-Extend%3CT%3E-for-IndexSet%3CT,+S,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#515-526">source</a><a href="#impl-Extend%3CT%3E-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> Extend<T> for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
T: 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" class="method trait-impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#520-525">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 = T>,</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-FromIterator%3CT%3E-for-IndexSet%3CT,+S,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#541-554">source</a><a href="#impl-FromIterator%3CT%3E-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> FromIterator<T> for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
T: 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/indexset.rs.html#546-553">source</a><a href="#method.from_iter" class="anchor">§</a><h4 class="code-header">fn <a class="fn">from_iter</a><I>(iter: I) -> Self<span class="where fmt-newline">where
|
||
I: IntoIterator<Item = T>,</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-IntoIterator-for-%26'a+IndexSet%3CT,+S,+N%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#556-567">source</a><a href="#impl-IntoIterator-for-%26'a+IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<'a, T, S, const N: usize> IntoIterator for &'a <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
T: 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 T</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, T></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/indexset.rs.html#564-566">source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a class="fn">into_iter</a>(self) -> Self::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%3CIndexSet%3CT,+S2,+N2%3E%3E-for-IndexSet%3CT,+S1,+N1%3E" class="impl"><a class="src rightside" href="../src/heapless/indexset.rs.html#503-513">source</a><a href="#impl-PartialEq%3CIndexSet%3CT,+S2,+N2%3E%3E-for-IndexSet%3CT,+S1,+N1%3E" class="anchor">§</a><h3 class="code-header">impl<T, S1, S2, const N1: usize, const N2: usize> PartialEq<<a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S2, N2>> for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S1, N1><span class="where fmt-newline">where
|
||
T: Eq + <a class="trait" href="../hash32/trait.Hash.html" title="trait hash32::Hash">Hash</a>,
|
||
S1: <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/indexset.rs.html#510-512">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.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, 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></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-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-RefUnwindSafe-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> RefUnwindSafe for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
S: RefUnwindSafe,
|
||
T: RefUnwindSafe,</span></h3></section><section id="impl-Send-for-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-Send-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> Send for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
S: Send,
|
||
T: Send,</span></h3></section><section id="impl-Sync-for-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-Sync-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> Sync for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
S: Sync,
|
||
T: Sync,</span></h3></section><section id="impl-Unpin-for-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-Unpin-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> Unpin for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
S: Unpin,
|
||
T: Unpin,</span></h3></section><section id="impl-UnwindSafe-for-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-UnwindSafe-for-IndexSet%3CT,+S,+N%3E" class="anchor">§</a><h3 class="code-header">impl<T, S, const N: usize> UnwindSafe for <a class="struct" href="struct.IndexSet.html" title="struct heapless::IndexSet">IndexSet</a><T, S, N><span class="where fmt-newline">where
|
||
S: UnwindSafe,
|
||
T: 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-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-Any-for-IndexSet%3CT,+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-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-Borrow%3CT%3E-for-IndexSet%3CT,+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-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-BorrowMut%3CT%3E-for-IndexSet%3CT,+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-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-From%3CT%3E-for-IndexSet%3CT,+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-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-Into%3CU%3E-for-IndexSet%3CT,+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-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-TryFrom%3CU%3E-for-IndexSet%3CT,+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-IndexSet%3CT,+S,+N%3E" class="impl"><a href="#impl-TryInto%3CU%3E-for-IndexSet%3CT,+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> |