mirror/rtic
1
0
Fork 0
mirror of https://github.com/rtic-rs/rtic.git synced 2024-12-27 04:19:33 +01:00
Code Issues Projects Releases Packages Wiki Activity
rtic/dev/api/hashbrown/hash_set/struct.HashSet.html

773 lines
166 KiB
HTML
Raw Permalink Normal View History

deploy: 1a1237690cf676733579ffde0f507a00950e474e
2024-12-06 14:35:18 +01:00
<!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="A hash set implemented as a `HashMap` where the value is `()`."><title>HashSet in hashbrown::hash_set - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-46f98efaafac5295.ttf.woff2,FiraSans-Regular-018c141bf0843ffd.woff2,FiraSans-Medium-8f9a781e4970d388.woff2,SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2,SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-b0742ba02757f159.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="hashbrown" data-themes="" data-resource-suffix="" data-rustdoc-version="1.83.0 (90b35a623 2024-11-26)" data-channel="1.83.0" data-search-js="search-f0d225181b97f9a4.js" data-settings-js="settings-805db61a62df4bd2.js" ><script src="../../static.files/storage-1d39b6787ed640ff.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-f070b9041d14864c.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-0111fcff984fae8f.css"></noscript><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" title="show sidebar"></button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../hashbrown/index.html">hashbrown</a><span class="version">0.15.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">HashSet</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul><h3><a href="#implementations">Methods</a></h3><ul class="block method"><li><a href="#method.allocation_size" title="allocation_size">allocation_size</a></li><li><a href="#method.allocator" title="allocator">allocator</a></li><li><a href="#method.capacity" title="capacity">capacity</a></li><li><a href="#method.clear" title="clear">clear</a></li><li><a href="#method.contains" title="contains">contains</a></li><li><a href="#method.difference" title="difference">difference</a></li><li><a href="#method.drain" title="drain">drain</a></li><li><a href="#method.entry" title="entry">entry</a></li><li><a href="#method.extract_if" title="extract_if">extract_if</a></li><li><a href="#method.get" title="get">get</a></li><li><a href="#method.get_or_insert" title="get_or_insert">get_or_insert</a></li><li><a href="#method.get_or_insert_with" title="get_or_insert_with">get_or_insert_with</a></li><li><a href="#method.hasher" title="hasher">hasher</a></li><li><a href="#method.insert" title="insert">insert</a></li><li><a href="#method.insert_unique_unchecked" title="insert_unique_unchecked">insert_unique_unchecked</a></li><li><a href="#method.intersection" title="intersection">intersection</a></li><li><a href="#method.is_disjoint" title="is_disjoint">is_disjoint</a></li><li><a href="#method.is_empty" title="is_empty">is_empty</a></li><li><a href="#method.is_subset" title="is_subset">is_subset</a></li><li><a href="#method.is_superset" title="is_superset">is_superset</a></li><li><a href="#method.iter" title="iter">iter</a></li><li><a href="#method.len" title="len">len</a></li><li><a href="#method.remove" title="remove">remove</a></li><li><a href="#method.replace" title="replace">replace</a></li><li><a h
<p>As with the <a href="struct.HashMap.html"><code>HashMap</code></a> type, a <code>HashSet</code> requires that the elements
implement the <a href="https://doc.rust-lang.org/std/cmp/trait.Eq.html"><code>Eq</code></a> and <a href="https://doc.rust-lang.org/std/hash/trait.Hash.html"><code>Hash</code></a> traits. This can frequently be achieved by
using <code>#[derive(PartialEq, Eq, Hash)]</code>. If you implement these yourself,
it is important that the following property holds:</p>
<div class="example-wrap"><pre class="language-text"><code>k1 == k2 -&gt; hash(k1) == hash(k2)</code></pre></div>
<p>In other words, if two keys are equal, their hashes must be equal.</p>
<p>It is a logic error for an item to be modified in such a way that the
item’s hash, as determined by the <a href="https://doc.rust-lang.org/std/hash/trait.Hash.html"><code>Hash</code></a> trait, or its equality, as
determined by the <a href="https://doc.rust-lang.org/std/cmp/trait.Eq.html"><code>Eq</code></a> trait, changes while it is in the set. This is
normally only possible through <a href="https://doc.rust-lang.org/std/cell/struct.Cell.html"><code>Cell</code></a>, <a href="https://doc.rust-lang.org/std/cell/struct.RefCell.html"><code>RefCell</code></a>, global state, I/O, or
unsafe code.</p>
<p>It is also a logic error for the <a href="https://doc.rust-lang.org/std/hash/trait.Hash.html"><code>Hash</code></a> implementation of a key to panic.
This is generally only possible if the trait is implemented manually. If a
panic does occur then the contents of the <code>HashSet</code> may become corrupted and
some items may be dropped from the table.</p>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="comment">// Type inference lets us omit an explicit type signature (which
// would be `HashSet&lt;String&gt;` in this example).
</span><span class="kw">let </span><span class="kw-2">mut </span>books = HashSet::new();
<span class="comment">// Add some books.
</span>books.insert(<span class="string">"A Dance With Dragons"</span>.to_string());
books.insert(<span class="string">"To Kill a Mockingbird"</span>.to_string());
books.insert(<span class="string">"The Odyssey"</span>.to_string());
books.insert(<span class="string">"The Great Gatsby"</span>.to_string());
<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">&amp;</span>books {
<span class="macro">println!</span>(<span class="string">"{}"</span>, book);
}</code></pre></div>
<p>The easiest way to use <code>HashSet</code> with a custom type is to derive
<a href="https://doc.rust-lang.org/std/cmp/trait.Eq.html"><code>Eq</code></a> and <a href="https://doc.rust-lang.org/std/hash/trait.Hash.html"><code>Hash</code></a>. We must also derive <a href="https://doc.rust-lang.org/std/cmp/trait.PartialEq.html"><code>PartialEq</code></a>. This will in the
future be implied by <a href="https://doc.rust-lang.org/std/cmp/trait.Eq.html"><code>Eq</code></a>.</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="attr">#[derive(Hash, Eq, PartialEq, Debug)]
</span><span class="kw">struct </span>Viking {
name: String,
power: usize,
}
<span class="kw">let </span><span class="kw-2">mut </span>vikings = HashSet::new();
vikings.insert(Viking { name: <span class="string">"Einar"</span>.to_string(), power: <span class="number">9 </span>});
vikings.insert(Viking { name: <span class="string">"Einar"</span>.to_string(), power: <span class="number">9 </span>});
vikings.insert(Viking { name: <span class="string">"Olaf"</span>.to_string(), power: <span class="number">4 </span>});
vikings.insert(Viking { name: <span class="string">"Harald"</span>.to_string(), power: <span class="number">8 </span>});
<span class="comment">// Use derived implementation to print the vikings.
</span><span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>vikings {
<span class="macro">println!</span>(<span class="string">"{:?}"</span>, x);
}</code></pre></div>
<p>A <code>HashSet</code> with fixed list of elements can be initialized from an array:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>viking_names: HashSet&lt;<span class="kw-2">&amp;</span><span class="lifetime">'static </span>str&gt; =
[ <span class="string">"Einar"</span>, <span class="string">"Olaf"</span>, <span class="string">"Harald" </span>].into_iter().collect();
<span class="comment">// use the values stored in the set</span></code></pre></div>
</div></details><h2 id="implementations" class="section-header">Implementations<a href="#implementations" class="anchor">§</a></h2><div id="implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#258-433">source</a><a href="#impl-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A: Allocator&gt; <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</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/hashbrown/set.rs.html#269-271">source</a><h4 class="code-header">pub fn <a href="#method.capacity" class="fn">capacity</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of elements the set can hold without reallocating.</p>
<h5 id="examples-1"><a class="doc-anchor" href="#examples-1">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>set: HashSet&lt;i32&gt; = HashSet::with_capacity(<span class="number">100</span>);
<span class="macro">assert!</span>(set.capacity() &gt;= <span class="number">100</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/hashbrown/set.rs.html#290-294">source</a><h4 class="code-header">pub fn <a href="#method.iter" class="fn">iter</a>(&amp;self) -&gt; <a class="struct" href="struct.Iter.html" title="struct hashbrown::hash_set::Iter">Iter</a>&lt;'_, T&gt; <a href="#" class="tooltip" data-notable-ty="Iter&lt;&#39;_, T&gt;">ⓘ</a></h4></section></summary><div class="docblock"><p>An iterator visiting all elements in arbitrary order.
The iterator element type is <code>&amp;'a T</code>.</p>
<h5 id="examples-2"><a class="doc-anchor" href="#examples-2">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::new();
set.insert(<span class="string">"a"</span>);
set.insert(<span class="string">"b"</span>);
<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.len" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#309-311">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fn">len</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of elements in the set.</p>
<h5 id="examples-3"><a class="doc-anchor" href="#examples-3">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>v = HashSet::new();
<span class="macro">assert_eq!</span>(v.len(), <span class="number">0</span>);
v.insert(<span class="number">1</span>);
<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/hashbrown/set.rs.html#326-328">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fn">is_empty</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the set contains no elements.</p>
<h5 id="examples-4"><a class="doc-anchor" href="#examples-4">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>v = HashSet::new();
<span class="macro">assert!</span>(v.is_empty());
v.insert(<span class="number">1</span>);
<span class="macro">assert!</span>(!v.is_empty());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.drain" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#348-352">source</a><h4 class="code-header">pub fn <a href="#method.drain" class="fn">drain</a>(&amp;mut self) -&gt; <a class="struct" href="struct.Drain.html" title="struct hashbrown::hash_set::Drain">Drain</a>&lt;'_, T, A&gt; <a href="#" class="tooltip" data-notable-ty="Drain&lt;&#39;_, T, A&gt;">ⓘ</a></h4></section></summary><div class="docblock"><p>Clears the set, returning all elements in an iterator.</p>
<h5 id="examples-5"><a class="doc-anchor" href="#examples-5">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="macro">assert!</span>(!set.is_empty());
<span class="comment">// print 1, 2, 3 in an arbitrary order
</span><span class="kw">for </span>i <span class="kw">in </span>set.drain() {
<span class="macro">println!</span>(<span class="string">"{}"</span>, i);
}
<span class="macro">assert!</span>(set.is_empty());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.retain" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#368-373">source</a><h4 class="code-header">pub fn <a href="#method.retain" class="fn">retain</a>&lt;F&gt;(&amp;mut self, f: F)<div class="where">where
F: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;T</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Retains only the elements specified by the predicate.</p>
<p>In other words, remove all elements <code>e</code> such that <code>f(&amp;e)</code> returns <code>false</code>.</p>
<h5 id="examples-6"><a class="doc-anchor" href="#examples-6">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>xs = [<span class="number">1</span>,<span class="number">2</span>,<span class="number">3</span>,<span class="number">4</span>,<span class="number">5</span>,<span class="number">6</span>];
<span class="kw">let </span><span class="kw-2">mut </span>set: HashSet&lt;i32&gt; = xs.into_iter().collect();
set.retain(|<span class="kw-2">&amp;</span>k| k % <span class="number">2 </span>== <span class="number">0</span>);
<span class="macro">assert_eq!</span>(set.len(), <span class="number">3</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.extract_if" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#404-415">source</a><h4 class="code-header">pub fn <a href="#method.extract_if" class="fn">extract_if</a>&lt;F&gt;(&amp;mut self, f: F) -&gt; <a class="struct" href="struct.ExtractIf.html" title="struct hashbrown::hash_set::ExtractIf">ExtractIf</a>&lt;'_, T, F, A&gt; <a href="#" class="tooltip" data-notable-ty="ExtractIf&lt;&#39;_, T, F, A&gt;">ⓘ</a><div class="where">where
F: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;T</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a>,</div></h4></section></summary><div class="docblock"><p>Drains elements which are true under the given predicate,
and returns an iterator over the removed items.</p>
<p>In other words, move all elements <code>e</code> such that <code>f(&amp;e)</code> returns <code>true</code> out
into another iterator.</p>
<p>If the returned <code>ExtractIf</code> is not exhausted, e.g. because it is dropped without iterating
or the iteration short-circuits, then the remaining elements will be retained.
Use <a href="struct.HashSet.html#method.retain" title="method hashbrown::hash_set::HashSet::retain"><code>retain()</code></a> with a negated predicate if you do not need the returned iterator.</p>
<h5 id="examples-7"><a class="doc-anchor" href="#examples-7">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set: HashSet&lt;i32&gt; = (<span class="number">0</span>..<span class="number">8</span>).collect();
<span class="kw">let </span>drained: HashSet&lt;i32&gt; = set.extract_if(|v| v % <span class="number">2 </span>== <span class="number">0</span>).collect();
<span class="kw">let </span><span class="kw-2">mut </span>evens = drained.into_iter().collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;();
<span class="kw">let </span><span class="kw-2">mut </span>odds = set.into_iter().collect::&lt;Vec&lt;<span class="kw">_</span>&gt;&gt;();
evens.sort();
odds.sort();
<span class="macro">assert_eq!</span>(evens, <span class="macro">vec!</span>[<span class="number">0</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="number">6</span>]);
<span class="macro">assert_eq!</span>(odds, <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">3</span>, <span class="number">5</span>, <span class="number">7</span>]);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.clear" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#430-432">source</a><h4 class="code-header">pub fn <a href="#method.clear" class="fn">clear</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Clears the set, removing all values.</p>
<h5 id="examples-8"><a class="doc-anchor" href="#examples-8">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>v = HashSet::new();
v.insert(<span class="number">1</span>);
v.clear();
<span class="macro">assert!</span>(v.is_empty());</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-HashSet%3CT,+S%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#435-512">source</a><a href="#impl-HashSet%3CT,+S%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S&gt; <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, Global&gt;</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.with_hasher" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#469-473">source</a><h4 class="code-header">pub const fn <a href="#method.with_hasher" class="fn">with_hasher</a>(hasher: S) -&gt; Self</h4></section></summary><div class="docblock"><p>Creates a new empty hash set which will use the given hasher to hash
keys.</p>
<p>The hash set is initially created with a capacity of 0, so it will not
allocate until it is first inserted into.</p>
<h5 id="hashdos-resistance"><a class="doc-anchor" href="#hashdos-resistance">§</a>HashDoS resistance</h5>
<p>The <code>hash_builder</code> normally use a fixed key by default and that does
not allow the <code>HashSet</code> to be protected against attacks such as <a href="https://en.wikipedia.org/wiki/Collision_attack"><code>HashDoS</code></a>.
Users who require HashDoS resistance should explicitly use
<a href="https://doc.rust-lang.org/std/collections/hash_map/struct.RandomState.html"><code>std::collections::hash_map::RandomState</code></a>
as the hasher when creating a <a href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet"><code>HashSet</code></a>.</p>
<p>The <code>hash_builder</code> passed should implement the <a href="https://doc.rust-lang.org/std/hash/trait.BuildHasher.html"><code>BuildHasher</code></a> trait for
the <code>HashSet</code> to be useful, see its documentation for details.</p>
<h5 id="examples-9"><a class="doc-anchor" href="#examples-9">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">use </span>hashbrown::DefaultHashBuilder;
<span class="kw">let </span>s = DefaultHashBuilder::default();
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::with_hasher(s);
set.insert(<span class="number">2</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_capacity_and_hasher" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#507-511">source</a><h4 class="code-header">pub fn <a href="#method.with_capacity_and_hasher" class="fn">with_capacity_and_hasher</a>(capacity: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>, hasher: S) -&gt; Self</h4></section></summary><div class="docblock"><p>Creates an empty <code>HashSet</code> with the specified capacity, using
<code>hasher</code> to hash the keys.</p>
<p>The hash set will be able to hold at least <code>capacity</code> elements without
reallocating. If <code>capacity</code> is 0, the hash set will not allocate.</p>
<h5 id="hashdos-resistance-1"><a class="doc-anchor" href="#hashdos-resistance-1">§</a>HashDoS resistance</h5>
<p>The <code>hash_builder</code> normally use a fixed key by default and that does
not allow the <code>HashSet</code> to be protected against attacks such as <a href="https://en.wikipedia.org/wiki/Collision_attack"><code>HashDoS</code></a>.
Users who require HashDoS resistance should explicitly use
<a href="https://doc.rust-lang.org/std/collections/hash_map/struct.RandomState.html"><code>std::collections::hash_map::RandomState</code></a>
as the hasher when creating a <a href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet"><code>HashSet</code></a>.</p>
<p>The <code>hash_builder</code> passed should implement the <a href="https://doc.rust-lang.org/std/hash/trait.BuildHasher.html"><code>BuildHasher</code></a> trait for
the <code>HashSet</code> to be useful, see its documentation for details.</p>
<h5 id="examples-10"><a class="doc-anchor" href="#examples-10">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">use </span>hashbrown::DefaultHashBuilder;
<span class="kw">let </span>s = DefaultHashBuilder::default();
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::with_capacity_and_hasher(<span class="number">10</span>, s);
set.insert(<span class="number">1</span>);</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-HashSet%3CT,+S,+A%3E-1" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#514-619">source</a><a href="#impl-HashSet%3CT,+S,+A%3E-1" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
A: Allocator,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.allocator" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#520-522">source</a><h4 class="code-header">pub fn <a href="#method.allocator" class="fn">allocator</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;A</a></h4></section></summary><div class="docblock"><p>Returns a reference to the underlying allocator.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_hasher_in" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#557-561">source</a><h4 class="code-header">pub const fn <a href="#method.with_hasher_in" class="fn">with_hasher_in</a>(hasher: S, alloc: A) -&gt; Self</h4></section></summary><div class="docblock"><p>Creates a new empty hash set which will use the given hasher to hash
keys.</p>
<p>The hash set is initially created with a capacity of 0, so it will not
allocate until it is first inserted into.</p>
<h5 id="hashdos-resistance-2"><a class="doc-anchor" href="#hashdos-resistance-2">§</a>HashDoS resistance</h5>
<p>The <code>hash_builder</code> normally use a fixed key by default and that does
not allow the <code>HashSet</code> to be protected against attacks such as <a href="https://en.wikipedia.org/wiki/Collision_attack"><code>HashDoS</code></a>.
Users who require HashDoS resistance should explicitly use
<a href="https://doc.rust-lang.org/std/collections/hash_map/struct.RandomState.html"><code>std::collections::hash_map::RandomState</code></a>
as the hasher when creating a <a href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet"><code>HashSet</code></a>.</p>
<p>The <code>hash_builder</code> passed should implement the <a href="https://doc.rust-lang.org/std/hash/trait.BuildHasher.html"><code>BuildHasher</code></a> trait for
the <code>HashSet</code> to be useful, see its documentation for details.</p>
<h5 id="examples-11"><a class="doc-anchor" href="#examples-11">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">use </span>hashbrown::DefaultHashBuilder;
<span class="kw">let </span>s = DefaultHashBuilder::default();
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::with_hasher(s);
set.insert(<span class="number">2</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.with_capacity_and_hasher_in" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#595-599">source</a><h4 class="code-header">pub fn <a href="#method.with_capacity_and_hasher_in" class="fn">with_capacity_and_hasher_in</a>(capacity: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>, hasher: S, alloc: A) -&gt; Self</h4></section></summary><div class="docblock"><p>Creates an empty <code>HashSet</code> with the specified capacity, using
<code>hasher</code> to hash the keys.</p>
<p>The hash set will be able to hold at least <code>capacity</code> elements without
reallocating. If <code>capacity</code> is 0, the hash set will not allocate.</p>
<h5 id="hashdos-resistance-3"><a class="doc-anchor" href="#hashdos-resistance-3">§</a>HashDoS resistance</h5>
<p>The <code>hash_builder</code> normally use a fixed key by default and that does
not allow the <code>HashSet</code> to be protected against attacks such as <a href="https://en.wikipedia.org/wiki/Collision_attack"><code>HashDoS</code></a>.
Users who require HashDoS resistance should explicitly use
<a href="https://doc.rust-lang.org/std/collections/hash_map/struct.RandomState.html"><code>std::collections::hash_map::RandomState</code></a>
as the hasher when creating a <a href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet"><code>HashSet</code></a>.</p>
<p>The <code>hash_builder</code> passed should implement the <a href="https://doc.rust-lang.org/std/hash/trait.BuildHasher.html"><code>BuildHasher</code></a> trait for
the <code>HashSet</code> to be useful, see its documentation for details.</p>
<h5 id="examples-12"><a class="doc-anchor" href="#examples-12">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">use </span>hashbrown::DefaultHashBuilder;
<span class="kw">let </span>s = DefaultHashBuilder::default();
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::with_capacity_and_hasher(<span class="number">10</span>, s);
set.insert(<span class="number">1</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.hasher" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#616-618">source</a><h4 class="code-header">pub fn <a href="#method.hasher" class="fn">hasher</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;S</a></h4></section></summary><div class="docblock"><p>Returns a reference to the set’s <a href="https://doc.rust-lang.org/std/hash/trait.BuildHasher.html"><code>BuildHasher</code></a>.</p>
<h5 id="examples-13"><a class="doc-anchor" href="#examples-13">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">use </span>hashbrown::DefaultHashBuilder;
<span class="kw">let </span>hasher = DefaultHashBuilder::default();
<span class="kw">let </span>set: HashSet&lt;i32&gt; = HashSet::with_hasher(hasher);
<span class="kw">let </span>hasher: <span class="kw-2">&amp;</span>DefaultHashBuilder = set.hasher();</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-HashSet%3CT,+S,+A%3E-2" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#621-1221">source</a><a href="#impl-HashSet%3CT,+S,+A%3E-2" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,
A: Allocator,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.reserve" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#649-651">source</a><h4 class="code-header">pub fn <a href="#method.reserve" class="fn">reserve</a>(&amp;mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Reserves capacity for at least <code>additional</code> more elements to be inserted
in the <code>HashSet</code>. The collection may reserve more space to avoid
frequent reallocations.</p>
<h5 id="panics"><a class="doc-anchor" href="#panics">§</a>Panics</h5>
<p>Panics if the new capacity exceeds <a href="https://doc.rust-lang.org/std/primitive.isize.html"><code>isize::MAX</code></a> bytes and <a href="https://doc.rust-lang.org/alloc/alloc/fn.handle_alloc_error.html"><code>abort</code></a> the program
in case of allocation error. Use <a href="struct.HashSet.html#method.try_reserve" title="method hashbrown::hash_set::HashSet::try_reserve"><code>try_reserve</code></a> instead
if you want to handle memory allocation failure.</p>
<h5 id="examples-14"><a class="doc-anchor" href="#examples-14">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set: HashSet&lt;i32&gt; = HashSet::new();
set.reserve(<span class="number">10</span>);
<span class="macro">assert!</span>(set.capacity() &gt;= <span class="number">10</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.try_reserve" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#670-672">source</a><h4 class="code-header">pub fn <a href="#method.try_reserve" class="fn">try_reserve</a>(&amp;mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, <a class="enum" href="../enum.TryReserveError.html" title="enum hashbrown::TryReserveError">TryReserveError</a>&gt;</h4></section></summary><div class="docblock"><p>Tries to reserve capacity for at least <code>additional</code> more elements to be inserted
in the given <code>HashSet&lt;K,V&gt;</code>. The collection may reserve more space to avoid
frequent reallocations.</p>
<h5 id="errors"><a class="doc-anchor" href="#errors">§</a>Errors</h5>
<p>If the capacity overflows, or the allocator reports a failure, then an error
is returned.</p>
<h5 id="examples-15"><a class="doc-anchor" href="#examples-15">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set: HashSet&lt;i32&gt; = HashSet::new();
set.try_reserve(<span class="number">10</span>).expect(<span class="string">"why is the test harness OOMing on 10 bytes?"</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.shrink_to_fit" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#691-693">source</a><h4 class="code-header">pub fn <a href="#method.shrink_to_fit" class="fn">shrink_to_fit</a>(&amp;mut self)</h4></section></summary><div class="docblock"><p>Shrinks the capacity of the set as much as possible. It will drop
down as much as possible while maintaining the internal rules
and possibly leaving some space in accordance with the resize policy.</p>
<h5 id="examples-16"><a class="doc-anchor" href="#examples-16">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::with_capacity(<span class="number">100</span>);
set.insert(<span class="number">1</span>);
set.insert(<span class="number">2</span>);
<span class="macro">assert!</span>(set.capacity() &gt;= <span class="number">100</span>);
set.shrink_to_fit();
<span class="macro">assert!</span>(set.capacity() &gt;= <span class="number">2</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.shrink_to" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#717-719">source</a><h4 class="code-header">pub fn <a href="#method.shrink_to" class="fn">shrink_to</a>(&amp;mut self, min_capacity: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a>)</h4></section></summary><div class="docblock"><p>Shrinks the capacity of the set with a lower limit. It will drop
down no lower than the supplied limit while maintaining the internal rules
and possibly leaving some space in accordance with the resize policy.</p>
<p>Panics if the current capacity is smaller than the supplied
minimum capacity.</p>
<h5 id="examples-17"><a class="doc-anchor" href="#examples-17">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::with_capacity(<span class="number">100</span>);
set.insert(<span class="number">1</span>);
set.insert(<span class="number">2</span>);
<span class="macro">assert!</span>(set.capacity() &gt;= <span class="number">100</span>);
set.shrink_to(<span class="number">10</span>);
<span class="macro">assert!</span>(set.capacity() &gt;= <span class="number">10</span>);
set.shrink_to(<span class="number">0</span>);
<span class="macro">assert!</span>(set.capacity() &gt;= <span class="number">2</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.difference" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#745-750">source</a><h4 class="code-header">pub fn <a href="#method.difference" class="fn">difference</a>&lt;'a&gt;(&amp;'a self, other: &amp;'a Self) -&gt; <a class="struct" href="struct.Difference.html" title="struct hashbrown::hash_set::Difference">Difference</a>&lt;'a, T, S, A&gt; <a href="#" class="tooltip" data-notable-ty="Difference&lt;&#39;a, T, S, A&gt;">ⓘ</a></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-18"><a class="doc-anchor" href="#examples-18">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>a: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].into_iter().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">&amp;</span>b) {
<span class="macro">println!</span>(<span class="string">"{}"</span>, x); <span class="comment">// Print 1
</span>}
<span class="kw">let </span>diff: HashSet&lt;<span class="kw">_</span>&gt; = a.difference(<span class="kw-2">&amp;</span>b).collect();
<span class="macro">assert_eq!</span>(diff, [<span class="number">1</span>].iter().collect());
<span class="comment">// Note that difference is not symmetric,
// and `b - a` means something else:
</span><span class="kw">let </span>diff: HashSet&lt;<span class="kw">_</span>&gt; = b.difference(<span class="kw-2">&amp;</span>a).collect();
<span class="macro">assert_eq!</span>(diff, [<span class="number">4</span>].iter().collect());</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/hashbrown/set.rs.html#774-778">source</a><h4 class="code-header">pub fn <a href="#method.symmetric_difference" class="fn">symmetric_difference</a>&lt;'a&gt;(
&amp;'a self,
other: &amp;'a Self,
) -&gt; <a class="struct" href="struct.SymmetricDifference.html" title="struct hashbrown::hash_set::SymmetricDifference">SymmetricDifference</a>&lt;'a, T, S, A&gt; <a href="#" class="tooltip" data-notable-ty="SymmetricDifference&lt;&#39;a, T, S, A&gt;">ⓘ</a></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-19"><a class="doc-anchor" href="#examples-19">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>a: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].into_iter().collect();
<span class="comment">// Print 1, 4 in arbitrary order.
</span><span class="kw">for </span>x <span class="kw">in </span>a.symmetric_difference(<span class="kw-2">&amp;</span>b) {
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
}
<span class="kw">let </span>diff1: HashSet&lt;<span class="kw">_</span>&gt; = a.symmetric_difference(<span class="kw-2">&amp;</span>b).collect();
<span class="kw">let </span>diff2: HashSet&lt;<span class="kw">_</span>&gt; = b.symmetric_difference(<span class="kw-2">&amp;</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());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.intersection" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#799-809">source</a><h4 class="code-header">pub fn <a href="#method.intersection" class="fn">intersection</a>&lt;'a&gt;(&amp;'a self, other: &amp;'a Self) -&gt; <a class="struct" href="struct.Intersection.html" title="struct hashbrown::hash_set::Intersection">Intersection</a>&lt;'a, T, S, A&gt; <a href="#" class="tooltip" data-notable-ty="Intersection&lt;&#39;a, T, S, A&gt;">ⓘ</a></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-20"><a class="doc-anchor" href="#examples-20">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>a: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].into_iter().collect();
<span class="comment">// Print 2, 3 in arbitrary order.
</span><span class="kw">for </span>x <span class="kw">in </span>a.intersection(<span class="kw-2">&amp;</span>b) {
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
}
<span class="kw">let </span>intersection: HashSet&lt;<span class="kw">_</span>&gt; = a.intersection(<span class="kw-2">&amp;</span>b).collect();
<span class="macro">assert_eq!</span>(intersection, [<span class="number">2</span>, <span class="number">3</span>].iter().collect());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.union" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#830-841">source</a><h4 class="code-header">pub fn <a href="#method.union" class="fn">union</a>&lt;'a&gt;(&amp;'a self, other: &amp;'a Self) -&gt; <a class="struct" href="struct.Union.html" title="struct hashbrown::hash_set::Union">Union</a>&lt;'a, T, S, A&gt; <a href="#" class="tooltip" data-notable-ty="Union&lt;&#39;a, T, S, A&gt;">ⓘ</a></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-21"><a class="doc-anchor" href="#examples-21">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>a: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">4</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].into_iter().collect();
<span class="comment">// Print 1, 2, 3, 4 in arbitrary order.
</span><span class="kw">for </span>x <span class="kw">in </span>a.union(<span class="kw-2">&amp;</span>b) {
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
}
<span class="kw">let union</span>: HashSet&lt;<span class="kw">_</span>&gt; = a.union(<span class="kw-2">&amp;</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());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.contains" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#862-867">source</a><h4 class="code-header">pub fn <a href="#method.contains" class="fn">contains</a>&lt;Q&gt;(&amp;self, value: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;Q</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a><div class="where">where
Q: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../trait.Equivalent.html" title="trait hashbrown::Equivalent">Equivalent</a>&lt;T&gt; + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></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
<a href="https://doc.rust-lang.org/std/hash/trait.Hash.html"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/std/cmp/trait.Eq.html"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
the value type.</p>
<h5 id="examples-22"><a class="doc-anchor" href="#examples-22">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>set: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="macro">assert_eq!</span>(set.contains(<span class="kw-2">&amp;</span><span class="number">1</span>), <span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(set.contains(<span class="kw-2">&amp;</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.get" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#888-897">source</a><h4 class="code-header">pub fn <a href="#method.get" class="fn">get</a>&lt;Q&gt;(&amp;self, value: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;Q</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;T</a>&gt;<div class="where">where
Q: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../trait.Equivalent.html" title="trait hashbrown::Equivalent">Equivalent</a>&lt;T&gt; + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Returns a reference to the value in the set, if any, that is equal to the given value.</p>
<p>The value may be any borrowed form of the set’s value type, but
<a href="https://doc.rust-lang.org/std/hash/trait.Hash.html"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/std/cmp/trait.Eq.html"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
the value type.</p>
<h5 id="examples-23"><a class="doc-anchor" href="#examples-23">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>set: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="macro">assert_eq!</span>(set.get(<span class="kw-2">&amp;</span><span class="number">2</span>), <span class="prelude-val">Some</span>(<span class="kw-2">&amp;</span><span class="number">2</span>));
<span class="macro">assert_eq!</span>(set.get(<span class="kw-2">&amp;</span><span class="number">4</span>), <span class="prelude-val">None</span>);</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_or_insert" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#914-921">source</a><h4 class="code-header">pub fn <a href="#method.get_or_insert" class="fn">get_or_insert</a>(&amp;mut self, value: T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;T</a></h4></section></summary><div class="docblock"><p>Inserts the given <code>value</code> into the set if it is not present, then
returns a reference to the value in the set.</p>
<h5 id="examples-24"><a class="doc-anchor" href="#examples-24">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="macro">assert_eq!</span>(set.len(), <span class="number">3</span>);
<span class="macro">assert_eq!</span>(set.get_or_insert(<span class="number">2</span>), <span class="kw-2">&amp;</span><span class="number">2</span>);
<span class="macro">assert_eq!</span>(set.get_or_insert(<span class="number">100</span>), <span class="kw-2">&amp;</span><span class="number">100</span>);
<span class="macro">assert_eq!</span>(set.len(), <span class="number">4</span>); <span class="comment">// 100 was inserted</span></code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.get_or_insert_with" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#949-964">source</a><h4 class="code-header">pub fn <a href="#method.get_or_insert_with" class="fn">get_or_insert_with</a>&lt;Q, F&gt;(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;Q</a>, f: F) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;T</a><div class="where">where
Q: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../trait.Equivalent.html" title="trait hashbrown::Equivalent">Equivalent</a>&lt;T&gt; + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
F: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;Q</a>) -&gt; T,</div></h4></section></summary><div class="docblock"><p>Inserts a value computed from <code>f</code> into the set if the given <code>value</code> is
not present, then returns a reference to the value in the set.</p>
<h5 id="examples-25"><a class="doc-anchor" href="#examples-25">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set: HashSet&lt;String&gt; = [<span class="string">"cat"</span>, <span class="string">"dog"</span>, <span class="string">"horse"</span>]
.iter().map(|<span class="kw-2">&amp;</span>pet| pet.to_owned()).collect();
<span class="macro">assert_eq!</span>(set.len(), <span class="number">3</span>);
<span class="kw">for </span><span class="kw-2">&amp;</span>pet <span class="kw">in </span><span class="kw-2">&amp;</span>[<span class="string">"cat"</span>, <span class="string">"dog"</span>, <span class="string">"fish"</span>] {
<span class="kw">let </span>value = set.get_or_insert_with(pet, str::to_owned);
<span class="macro">assert_eq!</span>(value, pet);
}
<span class="macro">assert_eq!</span>(set.len(), <span class="number">4</span>); <span class="comment">// a new "fish" was inserted</span></code></pre></div>
<p>The following example will panic because the new value doesn’t match.</p>
<div class="example-wrap should_panic"><a href="#" class="tooltip" title="This example panics">ⓘ</a><pre class="rust rust-example-rendered"><code><span class="kw">let </span><span class="kw-2">mut </span>set = hashbrown::HashSet::new();
set.get_or_insert_with(<span class="string">"rust"</span>, |<span class="kw">_</span>| String::new());</code></pre></div>
</div></details><details class="toggle method-toggle" open><summary><section id="method.entry" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1000-1005">source</a><h4 class="code-header">pub fn <a href="#method.entry" class="fn">entry</a>(&amp;mut self, value: T) -&gt; <a class="enum" href="enum.Entry.html" title="enum hashbrown::hash_set::Entry">Entry</a>&lt;'_, T, S, A&gt;</h4></section></summary><div class="docblock"><p>Gets the given value’s corresponding entry in the set for in-place manipulation.</p>
<h5 id="examples-26"><a class="doc-anchor" href="#examples-26">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">use </span>hashbrown::hash_set::Entry::<span class="kw-2">*</span>;
<span class="kw">let </span><span class="kw-2">mut </span>singles = HashSet::new();
<span class="kw">let </span><span class="kw-2">mut </span>dupes = HashSet::new();
<span class="kw">for </span>ch <span class="kw">in </span><span class="string">"a short treatise on fungi"</span>.chars() {
<span class="kw">if let </span>Vacant(dupe_entry) = dupes.entry(ch) {
<span class="comment">// We haven't already seen a duplicate, so
// check if we've at least seen it once.
</span><span class="kw">match </span>singles.entry(ch) {
Vacant(single_entry) =&gt; {
<span class="comment">// We found a new character for the first time.
</span>single_entry.insert();
}
Occupied(single_entry) =&gt; {
<span class="comment">// We've already seen this once, "move" it to dupes.
</span>single_entry.remove();
dupe_entry.insert();
}
}
}
}
<span class="macro">assert!</span>(!singles.contains(<span class="kw-2">&amp;</span><span class="string">'t'</span>) &amp;&amp; dupes.contains(<span class="kw-2">&amp;</span><span class="string">'t'</span>));
<span class="macro">assert!</span>(singles.contains(<span class="kw-2">&amp;</span><span class="string">'u'</span>) &amp;&amp; !dupes.contains(<span class="kw-2">&amp;</span><span class="string">'u'</span>));
<span class="macro">assert!</span>(!singles.contains(<span class="kw-2">&amp;</span><span class="string">'v'</span>) &amp;&amp; !dupes.contains(<span class="kw-2">&amp;</span><span class="string">'v'</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/hashbrown/set.rs.html#1024-1026">source</a><h4 class="code-header">pub fn <a href="#method.is_disjoint" class="fn">is_disjoint</a>(&amp;self, other: &amp;Self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></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-27"><a class="doc-anchor" href="#examples-27">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>a: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span><span class="kw-2">mut </span>b = HashSet::new();
<span class="macro">assert_eq!</span>(a.is_disjoint(<span class="kw-2">&amp;</span>b), <span class="bool-val">true</span>);
b.insert(<span class="number">4</span>);
<span class="macro">assert_eq!</span>(a.is_disjoint(<span class="kw-2">&amp;</span>b), <span class="bool-val">true</span>);
b.insert(<span class="number">1</span>);
<span class="macro">assert_eq!</span>(a.is_disjoint(<span class="kw-2">&amp;</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/hashbrown/set.rs.html#1045-1047">source</a><h4 class="code-header">pub fn <a href="#method.is_subset" class="fn">is_subset</a>(&amp;self, other: &amp;Self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></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-28"><a class="doc-anchor" href="#examples-28">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>sup: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::new();
<span class="macro">assert_eq!</span>(set.is_subset(<span class="kw-2">&amp;</span>sup), <span class="bool-val">true</span>);
set.insert(<span class="number">2</span>);
<span class="macro">assert_eq!</span>(set.is_subset(<span class="kw-2">&amp;</span>sup), <span class="bool-val">true</span>);
set.insert(<span class="number">4</span>);
<span class="macro">assert_eq!</span>(set.is_subset(<span class="kw-2">&amp;</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/hashbrown/set.rs.html#1070-1072">source</a><h4 class="code-header">pub fn <a href="#method.is_superset" class="fn">is_superset</a>(&amp;self, other: &amp;Self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns <code>true</code> if the set is a superset of another,
i.e., <code>self</code> contains at least all the values in <code>other</code>.</p>
<h5 id="examples-29"><a class="doc-anchor" href="#examples-29">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>sub: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>].into_iter().collect();
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::new();
<span class="macro">assert_eq!</span>(set.is_superset(<span class="kw-2">&amp;</span>sub), <span class="bool-val">false</span>);
set.insert(<span class="number">0</span>);
set.insert(<span class="number">1</span>);
<span class="macro">assert_eq!</span>(set.is_superset(<span class="kw-2">&amp;</span>sub), <span class="bool-val">false</span>);
set.insert(<span class="number">2</span>);
<span class="macro">assert_eq!</span>(set.is_superset(<span class="kw-2">&amp;</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/hashbrown/set.rs.html#1092-1094">source</a><h4 class="code-header">pub fn <a href="#method.insert" class="fn">insert</a>(&amp;mut self, value: T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></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-30"><a class="doc-anchor" href="#examples-30">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::new();
<span class="macro">assert_eq!</span>(set.insert(<span class="number">2</span>), <span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(set.insert(<span class="number">2</span>), <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.insert_unique_unchecked" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1120-1122">source</a><h4 class="code-header">pub unsafe fn <a href="#method.insert_unique_unchecked" class="fn">insert_unique_unchecked</a>(&amp;mut self, value: T) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;T</a></h4></section></summary><div class="docblock"><p>Insert a value the set without checking if the value already exists in the set.</p>
<p>This operation is faster than regular insert, because it does not perform
lookup before insertion.</p>
<p>This operation is useful during initial population of the set.
For example, when constructing a set from another set, we know
that values are unique.</p>
<h5 id="safety"><a class="doc-anchor" href="#safety">§</a>Safety</h5>
<p>This operation is safe if a value does not exist in the set.</p>
<p>However, if a value exists in the set already, the behavior is unspecified:
this operation may panic, loop forever, or any following operation with the set
may panic, loop forever or return arbitrary result.</p>
<p>That said, this operation (and following operations) are guaranteed to
not violate memory safety.</p>
<p>However this operation is still unsafe because the resulting <code>HashSet</code>
may be passed to unsafe code which does expect the set to behave
correctly, and would cause unsoundness as a result.</p>
</div></details><details class="toggle method-toggle" open><summary><section id="method.replace" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1140-1151">source</a><h4 class="code-header">pub fn <a href="#method.replace" class="fn">replace</a>(&amp;mut self, value: T) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;T&gt;</h4></section></summary><div class="docblock"><p>Adds a value to the set, replacing the existing value, if any, that is equal to the given
one. Returns the replaced value.</p>
<h5 id="examples-31"><a class="doc-anchor" href="#examples-31">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::new();
set.insert(Vec::&lt;i32&gt;::new());
<span class="macro">assert_eq!</span>(set.get(<span class="kw-2">&amp;</span>[][..]).unwrap().capacity(), <span class="number">0</span>);
set.replace(Vec::with_capacity(<span class="number">10</span>));
<span class="macro">assert_eq!</span>(set.get(<span class="kw-2">&amp;</span>[][..]).unwrap().capacity(), <span class="number">10</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/hashbrown/set.rs.html#1175-1180">source</a><h4 class="code-header">pub fn <a href="#method.remove" class="fn">remove</a>&lt;Q&gt;(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;Q</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a><div class="where">where
Q: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../trait.Equivalent.html" title="trait hashbrown::Equivalent">Equivalent</a>&lt;T&gt; + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Removes a value from the set. Returns whether the value was
present in the set.</p>
<p>The value may be any borrowed form of the set’s value type, but
<a href="https://doc.rust-lang.org/std/hash/trait.Hash.html"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/std/cmp/trait.Eq.html"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
the value type.</p>
<h5 id="examples-32"><a class="doc-anchor" href="#examples-32">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::new();
set.insert(<span class="number">2</span>);
<span class="macro">assert_eq!</span>(set.remove(<span class="kw-2">&amp;</span><span class="number">2</span>), <span class="bool-val">true</span>);
<span class="macro">assert_eq!</span>(set.remove(<span class="kw-2">&amp;</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.take" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1201-1210">source</a><h4 class="code-header">pub fn <a href="#method.take" class="fn">take</a>&lt;Q&gt;(&amp;mut self, value: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;Q</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;T&gt;<div class="where">where
Q: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="../trait.Equivalent.html" title="trait hashbrown::Equivalent">Equivalent</a>&lt;T&gt; + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Removes and returns the value in the set, if any, that is equal to the given one.</p>
<p>The value may be any borrowed form of the set’s value type, but
<a href="https://doc.rust-lang.org/std/hash/trait.Hash.html"><code>Hash</code></a> and <a href="https://doc.rust-lang.org/std/cmp/trait.Eq.html"><code>Eq</code></a> on the borrowed form <em>must</em> match those for
the value type.</p>
<h5 id="examples-33"><a class="doc-anchor" href="#examples-33">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set: HashSet&lt;<span class="kw">_</span>&gt; = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="macro">assert_eq!</span>(set.take(<span class="kw-2">&amp;</span><span class="number">2</span>), <span class="prelude-val">Some</span>(<span class="number">2</span>));
<span class="macro">assert_eq!</span>(set.take(<span class="kw-2">&amp;</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.allocation_size" class="method"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1218-1220">source</a><h4 class="code-header">pub fn <a href="#method.allocation_size" class="fn">allocation_size</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the total amount of memory allocated internally by the hash
set, in bytes.</p>
<p>The returned number is informational only. It is intended to be
primarily used for memory profiling.</p>
</div></details></div></details></div><h2 id="trait-implementations" class="section-header">Trait Implementations<a href="#trait-implementations" class="anchor">§</a></h2><div id="trait-implementations-list"><details class="toggle implementors-toggle" open><summary><section id="impl-BitAnd%3C%26HashSet%3CT,+S,+A%3E%3E-for-%26HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1395-1426">source</a><a href="#impl-BitAnd%3C%26HashSet%3CT,+S,+A%3E%3E-for-%26HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitAnd.html" title="trait core::ops::bit::BitAnd">BitAnd</a>&lt;&amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;&gt; for &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
A: Allocator + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.bitand" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1423-1425">source</a><a href="#method.bitand" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitAnd.html#tymethod.bitand" class="fn">bitand</a>(self, rhs: &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;) -&gt; <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</h4></section></summary><div class="docblock"><p>Returns the intersection of <code>self</code> and <code>rhs</code> as a new <code>HashSet&lt;T, S&gt;</code>.</p>
<h5 id="examples-35"><a class="doc-anchor" href="#examples-35">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>a: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].into_iter().collect();
<span class="kw">let </span>set = <span class="kw-2">&amp;</span>a &amp; <span class="kw-2">&amp;</span>b;
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
<span class="kw">let </span>expected = [<span class="number">2</span>, <span class="number">3</span>];
<span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>set {
<span class="macro">assert!</span>(expected.contains(x));
i += <span class="number">1</span>;
}
<span class="macro">assert_eq!</span>(i, expected.len());</code></pre></div>
</div></details><details class="toggle" open><summary><section id="associatedtype.Output-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1401">source</a><a href="#associatedtype.Output-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitAnd.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</h4></section></summary><div class='docblock'>The resulting type after applying the <code>&amp;</code> operator.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-BitAndAssign%3C%26HashSet%3CT,+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1529-1558">source</a><a href="#impl-BitAndAssign%3C%26HashSet%3CT,+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitAndAssign.html" title="trait core::ops::bit::BitAndAssign">BitAndAssign</a>&lt;&amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;&gt; for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,
A: Allocator,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.bitand_assign" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1555-1557">source</a><a href="#method.bitand_assign" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitAndAssign.html#tymethod.bitand_assign" class="fn">bitand_assign</a>(&amp;mut self, rhs: &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;)</h4></section></summary><div class="docblock"><p>Modifies this set to contain the intersection of <code>self</code> and <code>rhs</code>.</p>
<h5 id="examples-39"><a class="doc-anchor" href="#examples-39">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>a: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>].into_iter().collect();
a &amp;= <span class="kw-2">&amp;</span>b;
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
<span class="kw">let </span>expected = [<span class="number">2</span>, <span class="number">3</span>];
<span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>a {
<span class="macro">assert!</span>(expected.contains(x));
i += <span class="number">1</span>;
}
<span class="macro">assert_eq!</span>(i, expected.len());</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-BitOr%3C%26HashSet%3CT,+S,+A%3E%3E-for-%26HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1362-1393">source</a><a href="#impl-BitOr%3C%26HashSet%3CT,+S,+A%3E%3E-for-%26HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitOr.html" title="trait core::ops::bit::BitOr">BitOr</a>&lt;&amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;&gt; for &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
A: Allocator + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.bitor" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1390-1392">source</a><a href="#method.bitor" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitOr.html#tymethod.bitor" class="fn">bitor</a>(self, rhs: &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;) -&gt; <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</h4></section></summary><div class="docblock"><p>Returns the union of <code>self</code> and <code>rhs</code> as a new <code>HashSet&lt;T, S&gt;</code>.</p>
<h5 id="examples-34"><a class="doc-anchor" href="#examples-34">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>a: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>].into_iter().collect();
<span class="kw">let </span>set = <span class="kw-2">&amp;</span>a | <span class="kw-2">&amp;</span>b;
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
<span class="kw">let </span>expected = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
<span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>set {
<span class="macro">assert!</span>(expected.contains(x));
i += <span class="number">1</span>;
}
<span class="macro">assert_eq!</span>(i, expected.len());</code></pre></div>
</div></details><details class="toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1368">source</a><a href="#associatedtype.Output" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitOr.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</h4></section></summary><div class='docblock'>The resulting type after applying the <code>|</code> operator.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-BitOrAssign%3C%26HashSet%3CT,+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1494-1527">source</a><a href="#impl-BitOrAssign%3C%26HashSet%3CT,+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitOrAssign.html" title="trait core::ops::bit::BitOrAssign">BitOrAssign</a>&lt;&amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;&gt; for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,
A: Allocator,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.bitor_assign" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1520-1526">source</a><a href="#method.bitor_assign" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitOrAssign.html#tymethod.bitor_assign" class="fn">bitor_assign</a>(&amp;mut self, rhs: &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;)</h4></section></summary><div class="docblock"><p>Modifies this set to contain the union of <code>self</code> and <code>rhs</code>.</p>
<h5 id="examples-38"><a class="doc-anchor" href="#examples-38">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>a: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>].into_iter().collect();
a |= <span class="kw-2">&amp;</span>b;
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
<span class="kw">let </span>expected = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>];
<span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>a {
<span class="macro">assert!</span>(expected.contains(x));
i += <span class="number">1</span>;
}
<span class="macro">assert_eq!</span>(i, expected.len());</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-BitXor%3C%26HashSet%3CT,+S,+A%3E%3E-for-%26HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1428-1459">source</a><a href="#impl-BitXor%3C%26HashSet%3CT,+S,+A%3E%3E-for-%26HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitXor.html" title="trait core::ops::bit::BitXor">BitXor</a>&lt;&amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;&gt; for &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
A: Allocator + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.bitxor" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1456-1458">source</a><a href="#method.bitxor" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitXor.html#tymethod.bitxor" class="fn">bitxor</a>(self, rhs: &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;) -&gt; <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</h4></section></summary><div class="docblock"><p>Returns the symmetric difference of <code>self</code> and <code>rhs</code> as a new <code>HashSet&lt;T, S&gt;</code>.</p>
<h5 id="examples-36"><a class="doc-anchor" href="#examples-36">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>a: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>].into_iter().collect();
<span class="kw">let </span>set = <span class="kw-2">&amp;</span>a ^ <span class="kw-2">&amp;</span>b;
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
<span class="kw">let </span>expected = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="number">5</span>];
<span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>set {
<span class="macro">assert!</span>(expected.contains(x));
i += <span class="number">1</span>;
}
<span class="macro">assert_eq!</span>(i, expected.len());</code></pre></div>
</div></details><details class="toggle" open><summary><section id="associatedtype.Output-2" class="associatedtype trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1434">source</a><a href="#associatedtype.Output-2" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitXor.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</h4></section></summary><div class='docblock'>The resulting type after applying the <code>^</code> operator.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-BitXorAssign%3C%26HashSet%3CT,+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1560-1601">source</a><a href="#impl-BitXorAssign%3C%26HashSet%3CT,+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitXorAssign.html" title="trait core::ops::bit::BitXorAssign">BitXorAssign</a>&lt;&amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;&gt; for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,
A: Allocator,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.bitxor_assign" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1586-1600">source</a><a href="#method.bitxor_assign" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/ops/bit/trait.BitXorAssign.html#tymethod.bitxor_assign" class="fn">bitxor_assign</a>(&amp;mut self, rhs: &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;)</h4></section></summary><div class="docblock"><p>Modifies this set to contain the symmetric difference of <code>self</code> and <code>rhs</code>.</p>
<h5 id="examples-40"><a class="doc-anchor" href="#examples-40">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>a: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>].into_iter().collect();
a ^= <span class="kw-2">&amp;</span>b;
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
<span class="kw">let </span>expected = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">4</span>, <span class="number">5</span>];
<span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>a {
<span class="macro">assert!</span>(expected.contains(x));
i += <span class="number">1</span>;
}
<span class="macro">assert_eq!</span>(i, expected.len());</code></pre></div>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Clone-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#118-128">source</a><a href="#impl-Clone-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>, A: Allocator + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</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/hashbrown/set.rs.html#119-123">source</a><a href="#method.clone" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html#tymethod.clone" class="fn">clone</a>(&amp;self) -&gt; Self</h4></section></summary><div class='docblock'>Returns a copy of the value. <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html#tymethod.clone">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_from" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#125-127">source</a><a href="#method.clone_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html#method.clone_from" class="fn">clone_from</a>(&amp;mut self, source: &amp;Self)</h4></section></summary><div class='docblock'>Performs copy-assignment from <code>source</code>. <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html#method.clone_from">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Debug-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1246-1254">source</a><a href="#impl-Debug-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,
A: Allocator,</div></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/hashbrown/set.rs.html#1251-1253">source</a><a href="#method.fmt" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt" class="fn">fmt</a>(&amp;self, f: &amp;mut <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>&lt;'_&gt;) -&gt; <a class="type" href="https://doc.rust-lang.org/1.83.0/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/1.83.0/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Default-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1348-1360">source</a><a href="#impl-Default-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> + Allocator,</div></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/hashbrown/set.rs.html#1355-1359">source</a><a href="#method.default" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html#tymethod.default" class="fn">default</a>() -&gt; Self</h4></section></summary><div class="docblock"><p>Creates an empty <code>HashSet&lt;T, S&gt;</code> with the <code>Default</code> value for the hasher.</p>
</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Extend%3C%26T%3E-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1324-1346">source</a><a href="#impl-Extend%3C%26T%3E-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;'a T</a>&gt; for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: 'a + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Copy.html" title="trait core::marker::Copy">Copy</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,
A: Allocator,</div></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/hashbrown/set.rs.html#1331-1333">source</a><a href="#method.extend-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#tymethod.extend" class="fn">extend</a>&lt;I: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>&lt;Item = <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;'a T</a>&gt;&gt;(&amp;mut self, iter: I)</h4></section></summary><div class='docblock'>Extends a collection with the contents of an iterator. <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#tymethod.extend">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.extend_one-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/iter/traits/collect.rs.html#454">source</a><a href="#method.extend_one-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#method.extend_one" class="fn">extend_one</a>(&amp;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 class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/iter/traits/collect.rs.html#462">source</a><a href="#method.extend_reserve-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#method.extend_reserve" class="fn">extend_reserve</a>(&amp;mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</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'>Reserves capacity in a collection for the given number of additional elements. <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#method.extend_reserve">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Extend%3CT%3E-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1300-1322">source</a><a href="#impl-Extend%3CT%3E-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html" title="trait core::iter::traits::collect::Extend">Extend</a>&lt;T&gt; for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,
A: Allocator,</div></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/hashbrown/set.rs.html#1307-1309">source</a><a href="#method.extend" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#tymethod.extend" class="fn">extend</a>&lt;I: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>&lt;Item = T&gt;&gt;(&amp;mut self, iter: I)</h4></section></summary><div class='docblock'>Extends a collection with the contents of an iterator. <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#tymethod.extend">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.extend_one" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/iter/traits/collect.rs.html#454">source</a><a href="#method.extend_one" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#method.extend_one" class="fn">extend_one</a>(&amp;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 class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/iter/traits/collect.rs.html#462">source</a><a href="#method.extend_reserve" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#method.extend_reserve" class="fn">extend_reserve</a>(&amp;mut self, additional: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.usize.html">usize</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'>Reserves capacity in a collection for the given number of additional elements. <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.Extend.html#method.extend_reserve">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-From%3CHashMap%3CT,+(),+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1256-1263">source</a><a href="#impl-From%3CHashMap%3CT,+(),+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;<a class="struct" href="../hash_map/struct.HashMap.html" title="struct hashbrown::hash_map::HashMap">HashMap</a>&lt;T, <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, S, A&gt;&gt; for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
A: Allocator,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1260-1262">source</a><a href="#method.from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(map: <a class="struct" href="../hash_map/struct.HashMap.html" title="struct hashbrown::hash_map::HashMap">HashMap</a>&lt;T, <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.unit.html">()</a>, S, A&gt;) -&gt; Self</h4></section></summary><div class='docblock'>Converts to this type from the input type.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-FromIterator%3CT%3E-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1265-1277">source</a><a href="#impl-FromIterator%3CT%3E-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.FromIterator.html" title="trait core::iter::traits::collect::FromIterator">FromIterator</a>&lt;T&gt; for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a> + Allocator,</div></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/hashbrown/set.rs.html#1272-1276">source</a><a href="#method.from_iter" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.FromIterator.html#tymethod.from_iter" class="fn">from_iter</a>&lt;I: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>&lt;Item = T&gt;&gt;(iter: I) -&gt; Self</h4></section></summary><div class='docblock'>Creates a value from an iterator. <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.FromIterator.html#tymethod.from_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-%26HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1739-1747">source</a><a href="#impl-IntoIterator-for-%26HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;'a, T, S, A: Allocator&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a> for &amp;'a <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Item" class="associatedtype trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1740">source</a><a href="#associatedtype.Item" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;'a T</a></h4></section></summary><div class='docblock'>The type of the elements being iterated over.</div></details><details class="toggle" open><summary><section id="associatedtype.IntoIter" class="associatedtype trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1741">source</a><a href="#associatedtype.IntoIter" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="struct.Iter.html" title="struct hashbrown::hash_set::Iter">Iter</a>&lt;'a, T&gt;</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/hashbrown/set.rs.html#1744-1746">source</a><a href="#method.into_iter" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter" class="fn">into_iter</a>(self) -&gt; <a class="struct" href="struct.Iter.html" title="struct hashbrown::hash_set::Iter">Iter</a>&lt;'a, T&gt; <a href="#" class="tooltip" data-notable-ty="Iter&lt;&#39;a, T&gt;">ⓘ</a></h4></section></summary><div class='docblock'>Creates an iterator from a value. <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#tymethod.into_iter">Read more</a></div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-IntoIterator-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1749-1779">source<
of the set in arbitrary order. The set cannot be used after calling
this.</p>
<h5 id="examples-42"><a class="doc-anchor" href="#examples-42">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>set = HashSet::new();
set.insert(<span class="string">"a"</span>.to_string());
set.insert(<span class="string">"b"</span>.to_string());
<span class="comment">// Not possible to collect to a Vec&lt;String&gt; with a regular `.iter()`.
</span><span class="kw">let </span>v: Vec&lt;String&gt; = set.into_iter().collect();
<span class="comment">// Will print in an arbitrary order.
</span><span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>v {
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
}</code></pre></div>
</div></details><details class="toggle" open><summary><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1750">source</a><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" class="associatedtype">Item</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-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1751">source</a><a href="#associatedtype.IntoIter-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.IntoIter" class="associatedtype">IntoIter</a> = <a class="struct" href="struct.IntoIter.html" title="struct hashbrown::hash_set::IntoIter">IntoIter</a>&lt;T, A&gt;</h4></section></summary><div class='docblock'>Which kind of iterator are we turning this into?</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-PartialEq-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1223-1236">source</a><a href="#impl-PartialEq-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.PartialEq.html" title="trait core::cmp::PartialEq">PartialEq</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,
A: Allocator,</div></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/hashbrown/set.rs.html#1229-1235">source</a><a href="#method.eq" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.PartialEq.html#tymethod.eq" class="fn">eq</a>(&amp;self, other: &amp;Self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>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="rightside"><span class="since" title="Stable since Rust version 1.0.0">1.0.0</span> · <a class="src" href="https://doc.rust-lang.org/1.83.0/src/core/cmp.rs.html#261">source</a></span><a href="#method.ne" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.PartialEq.html#method.ne" class="fn">ne</a>(&amp;self, other: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;Rhs</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Tests for <code>!=</code>. The default implementation is almost always sufficient,
and should not be overridden without very good reason.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-Sub%3C%26HashSet%3CT,+S,+A%3E%3E-for-%26HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1461-1492">source</a><a href="#impl-Sub%3C%26HashSet%3CT,+S,+A%3E%3E-for-%26HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/arith/trait.Sub.html" title="trait core::ops::arith::Sub">Sub</a>&lt;&amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;&gt; for &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,
A: Allocator + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/default/trait.Default.html" title="trait core::default::Default">Default</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.sub" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1489-1491">source</a><a href="#method.sub" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/ops/arith/trait.Sub.html#tymethod.sub" class="fn">sub</a>(self, rhs: &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;) -&gt; <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</h4></section></summary><div class="docblock"><p>Returns the difference of <code>self</code> and <code>rhs</code> as a new <code>HashSet&lt;T, S&gt;</code>.</p>
<h5 id="examples-37"><a class="doc-anchor" href="#examples-37">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span>a: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>].into_iter().collect();
<span class="kw">let </span>set = <span class="kw-2">&amp;</span>a - <span class="kw-2">&amp;</span>b;
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
<span class="kw">let </span>expected = [<span class="number">1</span>, <span class="number">2</span>];
<span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>set {
<span class="macro">assert!</span>(expected.contains(x));
i += <span class="number">1</span>;
}
<span class="macro">assert_eq!</span>(i, expected.len());</code></pre></div>
</div></details><details class="toggle" open><summary><section id="associatedtype.Output-3" class="associatedtype trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1467">source</a><a href="#associatedtype.Output-3" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/ops/arith/trait.Sub.html#associatedtype.Output" class="associatedtype">Output</a> = <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;</h4></section></summary><div class='docblock'>The resulting type after applying the <code>-</code> operator.</div></details></div></details><details class="toggle implementors-toggle" open><summary><section id="impl-SubAssign%3C%26HashSet%3CT,+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1603-1638">source</a><a href="#impl-SubAssign%3C%26HashSet%3CT,+S,+A%3E%3E-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/ops/arith/trait.SubAssign.html" title="trait core::ops::arith::SubAssign">SubAssign</a>&lt;&amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;&gt; for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,
A: Allocator,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.sub_assign" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1629-1637">source</a><a href="#method.sub_assign" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/ops/arith/trait.SubAssign.html#tymethod.sub_assign" class="fn">sub_assign</a>(&amp;mut self, rhs: &amp;<a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;)</h4></section></summary><div class="docblock"><p>Modifies this set to contain the difference of <code>self</code> and <code>rhs</code>.</p>
<h5 id="examples-41"><a class="doc-anchor" href="#examples-41">§</a>Examples</h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>hashbrown::HashSet;
<span class="kw">let </span><span class="kw-2">mut </span>a: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>].into_iter().collect();
<span class="kw">let </span>b: HashSet&lt;<span class="kw">_</span>&gt; = <span class="macro">vec!</span>[<span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>].into_iter().collect();
a -= <span class="kw-2">&amp;</span>b;
<span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
<span class="kw">let </span>expected = [<span class="number">1</span>, <span class="number">2</span>];
<span class="kw">for </span>x <span class="kw">in </span><span class="kw-2">&amp;</span>a {
<span class="macro">assert!</span>(expected.contains(x));
i += <span class="number">1</span>;
}
<span class="macro">assert_eq!</span>(i, expected.len());</code></pre></div>
</div></details></div></details><section id="impl-Eq-for-HashSet%3CT,+S,+A%3E" class="impl"><a class="src rightside" href="../../src/hashbrown/set.rs.html#1238-1244">source</a><a href="#impl-Eq-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html" title="trait core::hash::Hash">Hash</a>,
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html" title="trait core::hash::BuildHasher">BuildHasher</a>,
A: Allocator,</div></h3></section></div><h2 id="synthetic-implementations" class="section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor">§</a></h2><div id="synthetic-implementations-list"><section id="impl-Freeze-for-HashSet%3CT,+S,+A%3E" class="impl"><a href="#impl-Freeze-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,
A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Freeze.html" title="trait core::marker::Freeze">Freeze</a>,</div></h3></section><section id="impl-RefUnwindSafe-for-HashSet%3CT,+S,+A%3E" class="impl"><a href="#impl-RefUnwindSafe-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a>,</div></h3></section><section id="impl-Send-for-HashSet%3CT,+S,+A%3E" class="impl"><a href="#impl-Send-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></h3></section><section id="impl-Sync-for-HashSet%3CT,+S,+A%3E" class="impl"><a href="#impl-Sync-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>,</div></h3></section><section id="impl-Unpin-for-HashSet%3CT,+S,+A%3E" class="impl"><a href="#impl-Unpin-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a>,</div></h3></section><section id="impl-UnwindSafe-for-HashSet%3CT,+S,+A%3E" class="impl"><a href="#impl-UnwindSafe-for-HashSet%3CT,+S,+A%3E" class="anchor">§</a><h3 class="code-header">impl&lt;T, S, A&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.HashSet.html" title="struct hashbrown::hash_set::HashSet">HashSet</a>&lt;T, S, A&gt;<div class="where">where
S: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
A: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a>,</div></h3></section></div><h2 id="blanket-implementations" class="section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor">§</a></h2><div id="blanket-implementations-list"><details class="toggle implementors-toggle"><summary><section id="impl-Any-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/any.rs.html#138">source</a><a href="#impl-Any-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<div class="where">where
T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/any.rs.html#139">source</a><a href="#method.type_id" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id" class="fn">type_id</a>(&amp;self) -&gt; <a class="struct" href="https://doc.rust-lang.org/1.83.0/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/1.83.0/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#209">source</a><a href="#impl-Borrow%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#211">source</a><a href="#method.borrow" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow" class="fn">borrow</a>(&amp;self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;T</a></h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#217">source</a><a href="#impl-BorrowMut%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a>&lt;T&gt; for T<div class="where">where
T: ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/borrow.rs.html#218">source</a><a href="#method.borrow_mut" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fn">borrow_mut</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;mut T</a></h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-CloneToUninit-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/clone.rs.html#273">source</a><a href="#impl-CloneToUninit-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.CloneToUninit.html" title="trait core::clone::CloneToUninit">CloneToUninit</a> for T<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.clone_to_uninit" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/clone.rs.html#275">source</a><a href="#method.clone_to_uninit" class="anchor">§</a><h4 class="code-header">unsafe fn <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit" class="fn">clone_to_uninit</a>(&amp;self, dst: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.pointer.html">*mut T</a>)</h4></section></summary><span class="item-info"><div class="stab unstable"><span class="emoji">🔬</span><span>This is a nightly-only experimental API. (<code>clone_to_uninit</code>)</span></div></span><div class='docblock'>Performs copy-assignment from <code>self</code> to <code>dst</code>. <a href="https://doc.rust-lang.org/1.83.0/core/clone/trait.CloneToUninit.html#tymethod.clone_to_uninit">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Equivalent%3CK%3E-for-Q" class="impl"><a class="src rightside" href="../../src/hashbrown/lib.rs.html#159-167">source</a><a href="#impl-Equivalent%3CK%3E-for-Q" class="anchor">§</a><h3 class="code-header">impl&lt;Q, K&gt; <a class="trait" href="../trait.Equivalent.html" title="trait hashbrown::Equivalent">Equivalent</a>&lt;K&gt; for Q<div class="where">where
Q: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html" title="trait core::cmp::Eq">Eq</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,
K: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a>&lt;Q&gt; + ?<a class="trait" href="https://doc.rust-lang.org/1.83.0/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.equivalent" class="method trait-impl"><a class="src rightside" href="../../src/hashbrown/lib.rs.html#164-166">source</a><a href="#method.equivalent" class="anchor">§</a><h4 class="code-header">fn <a href="../trait.Equivalent.html#tymethod.equivalent" class="fn">equivalent</a>(&amp;self, key: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;K</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.bool.html">bool</a></h4></section></summary><div class='docblock'>Checks if this value is equivalent to the given key. <a href="../trait.Equivalent.html#tymethod.equivalent">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#765">source</a><a href="#impl-From%3CT%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for T</h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.from-1" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#768">source</a><a href="#method.from-1" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html#tymethod.from" class="fn">from</a>(t: T) -&gt; T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#748-750">source</a><a href="#impl-Into%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle method-toggle" open><summary><section id="method.into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#758">source</a><a href="#method.into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html#tymethod.into" class="fn">into</a>(self) -&gt; U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p>
<p>That is, this conversion is whatever the implementation of
<code><a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.From.html" title="trait core::convert::From">From</a>&lt;T&gt; for U</code> chooses to do.</p>
</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-ToOwned-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/alloc/borrow.rs.html#82-84">source</a><a href="#impl-ToOwned-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/alloc/borrow/trait.ToOwned.html" title="trait alloc::borrow::ToOwned">ToOwned</a> for T<div class="where">where
T: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/clone/trait.Clone.html" title="trait core::clone::Clone">Clone</a>,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Owned" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/alloc/borrow.rs.html#86">source</a><a href="#associatedtype.Owned" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/alloc/borrow/trait.ToOwned.html#associatedtype.Owned" class="associatedtype">Owned</a> = T</h4></section></summary><div class='docblock'>The resulting type after obtaining ownership.</div></details><details class="toggle method-toggle" open><summary><section id="method.to_owned" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/alloc/borrow.rs.html#87">source</a><a href="#method.to_owned" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned" class="fn">to_owned</a>(&amp;self) -&gt; T</h4></section></summary><div class='docblock'>Creates owned data from borrowed data, usually by cloning. <a href="https://doc.rust-lang.org/1.83.0/alloc/borrow/trait.ToOwned.html#tymethod.to_owned">Read more</a></div></details><details class="toggle method-toggle" open><summary><section id="method.clone_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/alloc/borrow.rs.html#91">source</a><a href="#method.clone_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/alloc/borrow/trait.ToOwned.html#method.clone_into" class="fn">clone_into</a>(&amp;self, target: <a class="primitive" href="https://doc.rust-lang.org/1.83.0/core/primitive.reference.html">&amp;mut T</a>)</h4></section></summary><div class='docblock'>Uses borrowed data to replace owned data, usually by cloning. <a href="https://doc.rust-lang.org/1.83.0/alloc/borrow/trait.ToOwned.html#method.clone_into">Read more</a></div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#805-807">source</a><a href="#impl-TryFrom%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#809">source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#812">source</a><a href="#method.try_from" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#tymethod.try_from" class="fn">try_from</a>(value: U) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;T, &lt;T as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;U&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-T" class="impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#790-792">source</a><a href="#impl-TryInto%3CU%3E-for-T" class="anchor">§</a><h3 class="code-header">impl&lt;T, U&gt; <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a>&lt;U&gt; for T<div class="where">where
U: <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;,</div></h3></section></summary><div class="impl-items"><details class="toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#794">source</a><a href="#associatedtype.Error" class="anchor">§</a><h4 class="code-header">type <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl"><a class="src rightside" href="https://doc.rust-lang.org/1.83.0/src/core/convert/mod.rs.html#797">source</a><a href="#method.try_into" class="anchor">§</a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryInto.html#tymethod.try_into" class="fn">try_into</a>(self) -&gt; <a class="enum" href="https://doc.rust-lang.org/1.83.0/core/result/enum.Result.html" title="enum core::result::Result">Result</a>&lt;U, &lt;U as <a class="trait" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a>&lt;T&gt;&gt;::<a class="associatedtype" href="https://doc.rust-lang.org/1.83.0/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>&gt;</h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div><script type="text/json" id="notable-traits-data">{"Difference<'a, T, S, A>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.Difference.html\" title=\"struct hashbrown::hash_set::Difference\">Difference</a>&lt;'a, T, S, A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;'a, T, S, A&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.83.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.Difference.html\" title=\"struct hashbrown::hash_set::Difference\">Difference</a>&lt;'a, T, S, A&gt;<div class=\"where\">where\n T: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.83.0/core/cmp/trait.Eq.html\" title=\"trait core::cmp::Eq\">Eq</a> + <a class=\"trait\" href=\"https://doc.rust-lang.org/1.83.0/core/hash/trait.Hash.html\" title=\"trait core::hash::Hash\">Hash</a>,\n S: <a class=\"trait\" href=\"https://doc.rust-lang.org/1.83.0/core/hash/trait.BuildHasher.html\" title=\"trait core::hash::BuildHasher\">BuildHasher</a>,\n A: Allocator,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.83.0/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item\" class=\"associatedtype\">Item</a> = <a class=\"primitive\" href=\"https://doc.rust-lang.org/1.83.0/core/primitive.reference.html\">&amp;'a T</a>;</div>","Drain<'_, T, A>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.Drain.html\" title=\"struct hashbrown::hash_set::Drain\">Drain</a>&lt;'_, K, A&gt;</code></h3><pre><code><div class=\"where\">impl&lt;K, A: Allocator&gt; <a class=\"trait\" href=\"https://doc.rust-lang.org/1.83.0/core/iter/traits/iterator/trait.Iterator.html\" title=\"trait core::iter::traits::iterator::Iterator\">Iterator</a> for <a class=\"struct\" href=\"struct.Drain.html\" title=\"struct hashbrown::hash_set::Drain\">Drain</a>&lt;'_, K, A&gt;</div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.83.0/core/i
Reference in a new issue Copy permalink