oxipng/doc/bitflags/__core/collections/struct.HashSet.html

618 lines
No EOL
85 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters

This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.

<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<meta name="generator" content="rustdoc">
<meta name="description" content="API documentation for the Rust `HashSet` struct in crate `bitflags`.">
<meta name="keywords" content="rust, rustlang, rust-lang, HashSet">
<title>bitflags::__core::collections::HashSet - Rust</title>
<link rel="stylesheet" type="text/css" href="../../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../../main.css">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<p class='location'><a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>collections</a></p><script>window.sidebarCurrent = {name: 'HashSet', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<nav class="sub">
<form class="search-form js-only">
<div class="search-container">
<input class="search-input" name="search"
autocomplete="off"
placeholder="Click or press S to search, ? for more options…"
type="search">
</div>
</form>
</nav>
<section id='main' class="content struct">
<h1 class='fqn'><span class='in-band'>Struct <a href='../../index.html'>bitflags</a>::<wbr><a href='../index.html'>__core</a>::<wbr><a href='index.html'>collections</a>::<wbr><a class='struct' href=''>HashSet</a></span><span class='out-of-band'><span id='render-detail'>
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
[<span class='inner'>&#x2212;</span>]
</a>
</span><a id='src-2377' class='srclink' href='https://doc.rust-lang.org/nightly/std/collections/hash/set/struct.HashSet.html?gotosrc=2377' title='goto source code'>[src]</a></span></h1>
<pre class='rust struct'>pub struct HashSet&lt;T, S = <a class='struct' href='../../../bitflags/__core/collections/hash_map/struct.RandomState.html' title='bitflags::__core::collections::hash_map::RandomState'>RandomState</a>&gt; {
// some fields omitted
}</pre><span class="since">1.0.0</span><div class='docblock'><p>An implementation of a hash set using the underlying representation of a
HashMap where the value is ().</p>
<p>As with the <code>HashMap</code> type, a <code>HashSet</code> requires that the elements
implement the <code>Eq</code> and <code>Hash</code> 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>
<pre><code class="language-text">k1 == k2 -&gt; hash(k1) == hash(k2)
</code></pre>
<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&#39;s hash, as determined by the <code>Hash</code> trait, or its equality, as
determined by the <code>Eq</code> trait, changes while it is in the set. This is
normally only possible through <code>Cell</code>, <code>RefCell</code>, global state, I/O, or
unsafe code.</p>
<h1 id='examples' class='section-header'><a href='#examples'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='comment'>// Type inference lets us omit an explicit type signature (which</span>
<span class='comment'>// would be `HashSet&lt;&amp;str&gt;` in this example).</span>
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>books</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='comment'>// Add some books.</span>
<span class='ident'>books</span>.<span class='ident'>insert</span>(<span class='string'>&quot;A Dance With Dragons&quot;</span>);
<span class='ident'>books</span>.<span class='ident'>insert</span>(<span class='string'>&quot;To Kill a Mockingbird&quot;</span>);
<span class='ident'>books</span>.<span class='ident'>insert</span>(<span class='string'>&quot;The Odyssey&quot;</span>);
<span class='ident'>books</span>.<span class='ident'>insert</span>(<span class='string'>&quot;The Great Gatsby&quot;</span>);
<span class='comment'>// Check for a specific one.</span>
<span class='kw'>if</span> <span class='op'>!</span><span class='ident'>books</span>.<span class='ident'>contains</span>(<span class='string'>&quot;The Winds of Winter&quot;</span>) {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;We have {} books, but The Winds of Winter ain&#39;t one.&quot;</span>,
<span class='ident'>books</span>.<span class='ident'>len</span>());
}
<span class='comment'>// Remove a book.</span>
<span class='ident'>books</span>.<span class='ident'>remove</span>(<span class='string'>&quot;The Odyssey&quot;</span>);
<span class='comment'>// Iterate over everything.</span>
<span class='kw'>for</span> <span class='ident'>book</span> <span class='kw'>in</span> <span class='kw-2'>&amp;</span><span class='ident'>books</span> {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{}&quot;</span>, <span class='ident'>book</span>);
}</pre>
<p>The easiest way to use <code>HashSet</code> with a custom type is to derive
<code>Eq</code> and <code>Hash</code>. We must also derive <code>PartialEq</code>, this will in the
future be implied by <code>Eq</code>.</p>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='attribute'>#[<span class='ident'>derive</span>(<span class='ident'>Hash</span>, <span class='ident'>Eq</span>, <span class='ident'>PartialEq</span>, <span class='ident'>Debug</span>)]</span>
<span class='kw'>struct</span> <span class='ident'>Viking</span><span class='op'>&lt;</span><span class='lifetime'>&#39;a</span><span class='op'>&gt;</span> {
<span class='ident'>name</span>: <span class='kw-2'>&amp;</span><span class='lifetime'>&#39;a</span> <span class='ident'>str</span>,
<span class='ident'>power</span>: <span class='ident'>usize</span>,
}
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>vikings</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='ident'>vikings</span>.<span class='ident'>insert</span>(<span class='ident'>Viking</span> { <span class='ident'>name</span>: <span class='string'>&quot;Einar&quot;</span>, <span class='ident'>power</span>: <span class='number'>9</span> });
<span class='ident'>vikings</span>.<span class='ident'>insert</span>(<span class='ident'>Viking</span> { <span class='ident'>name</span>: <span class='string'>&quot;Einar&quot;</span>, <span class='ident'>power</span>: <span class='number'>9</span> });
<span class='ident'>vikings</span>.<span class='ident'>insert</span>(<span class='ident'>Viking</span> { <span class='ident'>name</span>: <span class='string'>&quot;Olaf&quot;</span>, <span class='ident'>power</span>: <span class='number'>4</span> });
<span class='ident'>vikings</span>.<span class='ident'>insert</span>(<span class='ident'>Viking</span> { <span class='ident'>name</span>: <span class='string'>&quot;Harald&quot;</span>, <span class='ident'>power</span>: <span class='number'>8</span> });
<span class='comment'>// Use derived implementation to print the vikings.</span>
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='kw-2'>&amp;</span><span class='ident'>vikings</span> {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{:?}&quot;</span>, <span class='ident'>x</span>);
}</pre>
</div><h2 id='methods'>Methods</h2><h3 class='impl'><code>impl&lt;T&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, <a class='struct' href='../../../bitflags/__core/collections/hash_map/struct.RandomState.html' title='bitflags::__core::collections::hash_map::RandomState'>RandomState</a>&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a></span></code></h3><div class='impl-items'><h4 id='method.new' class='method'><code>fn <a href='#method.new' class='fnname'>new</a>() -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, <a class='struct' href='../../../bitflags/__core/collections/hash_map/struct.RandomState.html' title='bitflags::__core::collections::hash_map::RandomState'>RandomState</a>&gt;</code></h4>
<div class='docblock'><p>Creates an empty HashSet.</p>
<h1 id='examples-1' class='section-header'><a href='#examples-1'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span><span class='ident'>i32</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();</pre>
</div><h4 id='method.with_capacity' class='method'><code>fn <a href='#method.with_capacity' class='fnname'>with_capacity</a>(capacity: <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.usize.html'>usize</a>) -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, <a class='struct' href='../../../bitflags/__core/collections/hash_map/struct.RandomState.html' title='bitflags::__core::collections::hash_map::RandomState'>RandomState</a>&gt;</code></h4>
<div class='docblock'><p>Creates an empty HashSet with space for at least <code>n</code> elements in
the hash table.</p>
<h1 id='examples-2' class='section-header'><a href='#examples-2'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span><span class='ident'>i32</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>with_capacity</span>(<span class='number'>10</span>);</pre>
</div></div><h3 class='impl'><code>impl&lt;T, S&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a>, T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a></span></code></h3><div class='impl-items'><h4 id='method.with_hasher' class='method'><code>fn <a href='#method.with_hasher' class='fnname'>with_hasher</a>(hasher: S) -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code><span class="since">1.7.0</span></h4>
<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 also created with the default initial capacity.</p>
<p>Warning: <code>hasher</code> is normally randomly generated, and
is designed to allow <code>HashSet</code>s to be resistant to attacks that
cause many collisions and very poor performance. Setting it
manually using this function can expose a DoS attack vector.</p>
<h1 id='examples-3' class='section-header'><a href='#examples-3'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>hash_map</span>::<span class='ident'>RandomState</span>;
<span class='kw'>let</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='ident'>RandomState</span>::<span class='ident'>new</span>();
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>with_hasher</span>(<span class='ident'>s</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>2</span>);</pre>
</div><h4 id='method.with_capacity_and_hasher' class='method'><code>fn <a href='#method.with_capacity_and_hasher' class='fnname'>with_capacity_and_hasher</a>(capacity: <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.usize.html'>usize</a>, hasher: S) -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code><span class="since">1.7.0</span></h4>
<div class='docblock'><p>Creates an empty HashSet with space for at least <code>capacity</code>
elements in the hash table, using <code>hasher</code> to hash the keys.</p>
<p>Warning: <code>hasher</code> is normally randomly generated, and
is designed to allow <code>HashSet</code>s to be resistant to attacks that
cause many collisions and very poor performance. Setting it
manually using this function can expose a DoS attack vector.</p>
<h1 id='examples-4' class='section-header'><a href='#examples-4'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>hash_map</span>::<span class='ident'>RandomState</span>;
<span class='kw'>let</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='ident'>RandomState</span>::<span class='ident'>new</span>();
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>with_capacity_and_hasher</span>(<span class='number'>10</span>, <span class='ident'>s</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>1</span>);</pre>
</div><h4 id='method.hasher' class='method'><code>fn <a href='#method.hasher' class='fnname'>hasher</a>(&amp;self) -&gt; &amp;S</code><span class="since">1.9.0</span></h4>
<div class='docblock'><p>Returns a reference to the set&#39;s hasher.</p>
</div><h4 id='method.capacity' class='method'><code>fn <a href='#method.capacity' class='fnname'>capacity</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.usize.html'>usize</a></code></h4>
<div class='docblock'><p>Returns the number of elements the set can hold without reallocating.</p>
<h1 id='examples-5' class='section-header'><a href='#examples-5'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>set</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span><span class='ident'>i32</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>with_capacity</span>(<span class='number'>100</span>);
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>capacity</span>() <span class='op'>&gt;=</span> <span class='number'>100</span>);</pre>
</div><h4 id='method.reserve' class='method'><code>fn <a href='#method.reserve' class='fnname'>reserve</a>(&amp;mut self, additional: <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.usize.html'>usize</a>)</code></h4>
<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>
<h1 id='panics' class='section-header'><a href='#panics'>Panics</a></h1>
<p>Panics if the new allocation size overflows <code>usize</code>.</p>
<h1 id='examples-6' class='section-header'><a href='#examples-6'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span><span class='ident'>i32</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='ident'>set</span>.<span class='ident'>reserve</span>(<span class='number'>10</span>);</pre>
</div><h4 id='method.shrink_to_fit' class='method'><code>fn <a href='#method.shrink_to_fit' class='fnname'>shrink_to_fit</a>(&amp;mut self)</code></h4>
<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>
<h1 id='examples-7' class='section-header'><a href='#examples-7'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>with_capacity</span>(<span class='number'>100</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>1</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>2</span>);
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>capacity</span>() <span class='op'>&gt;=</span> <span class='number'>100</span>);
<span class='ident'>set</span>.<span class='ident'>shrink_to_fit</span>();
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>capacity</span>() <span class='op'>&gt;=</span> <span class='number'>2</span>);</pre>
</div><h4 id='method.iter' class='method'><code>fn <a href='#method.iter' class='fnname'>iter</a>(&amp;self) -&gt; <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.Iter.html' title='bitflags::__core::collections::hash_set::Iter'>Iter</a>&lt;T&gt;</code></h4>
<div class='docblock'><p>An iterator visiting all elements in arbitrary order.
Iterator element type is &amp;&#39;a T.</p>
<h1 id='examples-8' class='section-header'><a href='#examples-8'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='string'>&quot;a&quot;</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='string'>&quot;b&quot;</span>);
<span class='comment'>// Will print in an arbitrary order.</span>
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='ident'>set</span>.<span class='ident'>iter</span>() {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{}&quot;</span>, <span class='ident'>x</span>);
}</pre>
</div><h4 id='method.difference' class='method'><code>fn <a href='#method.difference' class='fnname'>difference</a>(&amp;'a self, other: &amp;'a <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.Difference.html' title='bitflags::__core::collections::hash_set::Difference'>Difference</a>&lt;'a, T, S&gt;</code></h4>
<div class='docblock'><p>Visit the values representing the difference.</p>
<h1 id='examples-9' class='section-header'><a href='#examples-9'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>b</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>4</span>, <span class='number'>2</span>, <span class='number'>3</span>, <span class='number'>4</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='comment'>// Can be seen as `a - b`.</span>
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='ident'>a</span>.<span class='ident'>difference</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>) {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{}&quot;</span>, <span class='ident'>x</span>); <span class='comment'>// Print 1</span>
}
<span class='kw'>let</span> <span class='ident'>diff</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>a</span>.<span class='ident'>difference</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>).<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>diff</span>, [<span class='number'>1</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>());
<span class='comment'>// Note that difference is not symmetric,</span>
<span class='comment'>// and `b - a` means something else:</span>
<span class='kw'>let</span> <span class='ident'>diff</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>b</span>.<span class='ident'>difference</span>(<span class='kw-2'>&amp;</span><span class='ident'>a</span>).<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>diff</span>, [<span class='number'>4</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>());</pre>
</div><h4 id='method.symmetric_difference' class='method'><code>fn <a href='#method.symmetric_difference' class='fnname'>symmetric_difference</a>(&amp;'a self, other: &amp;'a <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.SymmetricDifference.html' title='bitflags::__core::collections::hash_set::SymmetricDifference'>SymmetricDifference</a>&lt;'a, T, S&gt;</code></h4>
<div class='docblock'><p>Visit the values representing the symmetric difference.</p>
<h1 id='examples-10' class='section-header'><a href='#examples-10'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>b</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>4</span>, <span class='number'>2</span>, <span class='number'>3</span>, <span class='number'>4</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='comment'>// Print 1, 4 in arbitrary order.</span>
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='ident'>a</span>.<span class='ident'>symmetric_difference</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>) {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{}&quot;</span>, <span class='ident'>x</span>);
}
<span class='kw'>let</span> <span class='ident'>diff1</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>a</span>.<span class='ident'>symmetric_difference</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>).<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>diff2</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>b</span>.<span class='ident'>symmetric_difference</span>(<span class='kw-2'>&amp;</span><span class='ident'>a</span>).<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>diff1</span>, <span class='ident'>diff2</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>diff1</span>, [<span class='number'>1</span>, <span class='number'>4</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>());</pre>
</div><h4 id='method.intersection' class='method'><code>fn <a href='#method.intersection' class='fnname'>intersection</a>(&amp;'a self, other: &amp;'a <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.Intersection.html' title='bitflags::__core::collections::hash_set::Intersection'>Intersection</a>&lt;'a, T, S&gt;</code></h4>
<div class='docblock'><p>Visit the values representing the intersection.</p>
<h1 id='examples-11' class='section-header'><a href='#examples-11'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>b</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>4</span>, <span class='number'>2</span>, <span class='number'>3</span>, <span class='number'>4</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='comment'>// Print 2, 3 in arbitrary order.</span>
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='ident'>a</span>.<span class='ident'>intersection</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>) {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{}&quot;</span>, <span class='ident'>x</span>);
}
<span class='kw'>let</span> <span class='ident'>intersection</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>a</span>.<span class='ident'>intersection</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>).<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>intersection</span>, [<span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>());</pre>
</div><h4 id='method.union' class='method'><code>fn <a href='#method.union' class='fnname'>union</a>(&amp;'a self, other: &amp;'a <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.Union.html' title='bitflags::__core::collections::hash_set::Union'>Union</a>&lt;'a, T, S&gt;</code></h4>
<div class='docblock'><p>Visit the values representing the union.</p>
<h1 id='examples-12' class='section-header'><a href='#examples-12'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>b</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>4</span>, <span class='number'>2</span>, <span class='number'>3</span>, <span class='number'>4</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='comment'>// Print 1, 2, 3, 4 in arbitrary order.</span>
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='ident'>a</span>.<span class='ident'>union</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>) {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{}&quot;</span>, <span class='ident'>x</span>);
}
<span class='kw'>let</span> <span class='ident'>union</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>a</span>.<span class='ident'>union</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>).<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>union</span>, [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>, <span class='number'>4</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>());</pre>
</div><h4 id='method.len' class='method'><code>fn <a href='#method.len' class='fnname'>len</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.usize.html'>usize</a></code></h4>
<div class='docblock'><p>Returns the number of elements in the set.</p>
<h1 id='examples-13' class='section-header'><a href='#examples-13'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>v</span>.<span class='ident'>len</span>(), <span class='number'>0</span>);
<span class='ident'>v</span>.<span class='ident'>insert</span>(<span class='number'>1</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>v</span>.<span class='ident'>len</span>(), <span class='number'>1</span>);</pre>
</div><h4 id='method.is_empty' class='method'><code>fn <a href='#method.is_empty' class='fnname'>is_empty</a>(&amp;self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<div class='docblock'><p>Returns true if the set contains no elements.</p>
<h1 id='examples-14' class='section-header'><a href='#examples-14'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>v</span>.<span class='ident'>is_empty</span>());
<span class='ident'>v</span>.<span class='ident'>insert</span>(<span class='number'>1</span>);
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='op'>!</span><span class='ident'>v</span>.<span class='ident'>is_empty</span>());</pre>
</div><h4 id='method.drain' class='method'><code>fn <a href='#method.drain' class='fnname'>drain</a>(&amp;mut self) -&gt; <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.Drain.html' title='bitflags::__core::collections::hash_set::Drain'>Drain</a>&lt;T&gt;</code><span class="since">1.6.0</span></h4>
<div class='docblock'><p>Clears the set, returning all elements in an iterator.</p>
</div><h4 id='method.clear' class='method'><code>fn <a href='#method.clear' class='fnname'>clear</a>(&amp;mut self)</code></h4>
<div class='docblock'><p>Clears the set, removing all values.</p>
<h1 id='examples-15' class='section-header'><a href='#examples-15'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>v</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='ident'>v</span>.<span class='ident'>insert</span>(<span class='number'>1</span>);
<span class='ident'>v</span>.<span class='ident'>clear</span>();
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>v</span>.<span class='ident'>is_empty</span>());</pre>
</div><h4 id='method.contains' class='method'><code>fn <a href='#method.contains' class='fnname'>contains</a>&lt;Q&gt;(&amp;self, value: &amp;Q) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a> <span class='where'>where Q: <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a>, T: <a class='trait' href='../../../bitflags/__core/borrow/trait.Borrow.html' title='bitflags::__core::borrow::Borrow'>Borrow</a>&lt;Q&gt;</span></code></h4>
<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&#39;s value type, but
<code>Hash</code> and <code>Eq</code> on the borrowed form <em>must</em> match those for
the value type.</p>
<h1 id='examples-16' class='section-header'><a href='#examples-16'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>set</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>contains</span>(<span class='kw-2'>&amp;</span><span class='number'>1</span>), <span class='boolval'>true</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>contains</span>(<span class='kw-2'>&amp;</span><span class='number'>4</span>), <span class='boolval'>false</span>);</pre>
</div><h4 id='method.get' class='method'><code>fn <a href='#method.get' class='fnname'>get</a>&lt;Q&gt;(&amp;self, value: &amp;Q) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;&amp;T&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/borrow/trait.Borrow.html' title='bitflags::__core::borrow::Borrow'>Borrow</a>&lt;Q&gt;, Q: <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code><span class="since">1.9.0</span></h4>
<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&#39;s value type, but
<code>Hash</code> and <code>Eq</code> on the borrowed form <em>must</em> match those for
the value type.</p>
</div><h4 id='method.is_disjoint' class='method'><code>fn <a href='#method.is_disjoint' class='fnname'>is_disjoint</a>(&amp;self, other: &amp;<a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<div class='docblock'><p>Returns <code>true</code> if the set has no elements in common with <code>other</code>.
This is equivalent to checking for an empty intersection.</p>
<h1 id='examples-17' class='section-header'><a href='#examples-17'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>b</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>a</span>.<span class='ident'>is_disjoint</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>), <span class='boolval'>true</span>);
<span class='ident'>b</span>.<span class='ident'>insert</span>(<span class='number'>4</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>a</span>.<span class='ident'>is_disjoint</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>), <span class='boolval'>true</span>);
<span class='ident'>b</span>.<span class='ident'>insert</span>(<span class='number'>1</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>a</span>.<span class='ident'>is_disjoint</span>(<span class='kw-2'>&amp;</span><span class='ident'>b</span>), <span class='boolval'>false</span>);</pre>
</div><h4 id='method.is_subset' class='method'><code>fn <a href='#method.is_subset' class='fnname'>is_subset</a>(&amp;self, other: &amp;<a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<div class='docblock'><p>Returns <code>true</code> if the set is a subset of another.</p>
<h1 id='examples-18' class='section-header'><a href='#examples-18'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>sup</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>is_subset</span>(<span class='kw-2'>&amp;</span><span class='ident'>sup</span>), <span class='boolval'>true</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>2</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>is_subset</span>(<span class='kw-2'>&amp;</span><span class='ident'>sup</span>), <span class='boolval'>true</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>4</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>is_subset</span>(<span class='kw-2'>&amp;</span><span class='ident'>sup</span>), <span class='boolval'>false</span>);</pre>
</div><h4 id='method.is_superset' class='method'><code>fn <a href='#method.is_superset' class='fnname'>is_superset</a>(&amp;self, other: &amp;<a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<div class='docblock'><p>Returns <code>true</code> if the set is a superset of another.</p>
<h1 id='examples-19' class='section-header'><a href='#examples-19'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>sub</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>].<span class='ident'>iter</span>().<span class='ident'>cloned</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>is_superset</span>(<span class='kw-2'>&amp;</span><span class='ident'>sub</span>), <span class='boolval'>false</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>0</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>1</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>is_superset</span>(<span class='kw-2'>&amp;</span><span class='ident'>sub</span>), <span class='boolval'>false</span>);
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>2</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>is_superset</span>(<span class='kw-2'>&amp;</span><span class='ident'>sub</span>), <span class='boolval'>true</span>);</pre>
</div><h4 id='method.insert' class='method'><code>fn <a href='#method.insert' class='fnname'>insert</a>(&amp;mut self, value: T) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<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>
<h1 id='examples-20' class='section-header'><a href='#examples-20'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>2</span>), <span class='boolval'>true</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>2</span>), <span class='boolval'>false</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>len</span>(), <span class='number'>1</span>);</pre>
</div><h4 id='method.replace' class='method'><code>fn <a href='#method.replace' class='fnname'>replace</a>(&amp;mut self, value: T) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt;</code><span class="since">1.9.0</span></h4>
<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>
</div><h4 id='method.remove' class='method'><code>fn <a href='#method.remove' class='fnname'>remove</a>&lt;Q&gt;(&amp;mut self, value: &amp;Q) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a> <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/borrow/trait.Borrow.html' title='bitflags::__core::borrow::Borrow'>Borrow</a>&lt;Q&gt;, Q: <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a></span></code></h4>
<div class='docblock'><p>Removes a value from the set. Returns <code>true</code> if the value was
present in the set.</p>
<p>The value may be any borrowed form of the set&#39;s value type, but
<code>Hash</code> and <code>Eq</code> on the borrowed form <em>must</em> match those for
the value type.</p>
<h1 id='examples-21' class='section-header'><a href='#examples-21'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='number'>2</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>remove</span>(<span class='kw-2'>&amp;</span><span class='number'>2</span>), <span class='boolval'>true</span>);
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>set</span>.<span class='ident'>remove</span>(<span class='kw-2'>&amp;</span><span class='number'>2</span>), <span class='boolval'>false</span>);</pre>
</div><h4 id='method.take' class='method'><code>fn <a href='#method.take' class='fnname'>take</a>&lt;Q&gt;(&amp;mut self, value: &amp;Q) -&gt; <a class='enum' href='../../../bitflags/__core/option/enum.Option.html' title='bitflags::__core::option::Option'>Option</a>&lt;T&gt; <span class='where'>where Q: <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + ?<a class='trait' href='../../../bitflags/__core/marker/trait.Sized.html' title='bitflags::__core::marker::Sized'>Sized</a>, T: <a class='trait' href='../../../bitflags/__core/borrow/trait.Borrow.html' title='bitflags::__core::borrow::Borrow'>Borrow</a>&lt;Q&gt;</span></code><span class="since">1.9.0</span></h4>
<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&#39;s value type, but
<code>Hash</code> and <code>Eq</code> on the borrowed form <em>must</em> match those for
the value type.</p>
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><code>impl&lt;T, S&gt; <a class='trait' href='../../../bitflags/__core/cmp/trait.PartialEq.html' title='bitflags::__core::cmp::PartialEq'>PartialEq</a>&lt;<a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;&gt; for <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a>, T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a></span></code></h3><div class='impl-items'><h4 id='method.eq' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialEq.html#tymethod.eq' class='fnname'>eq</a>(&amp;self, other: &amp;<a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
<h4 id='method.ne' class='method'><code>fn <a href='../../../bitflags/__core/cmp/trait.PartialEq.html#method.ne' class='fnname'>ne</a>(&amp;self, other: &amp;Rhs) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.bool.html'>bool</a></code></h4>
</div><h3 class='impl'><code>impl&lt;T, S&gt; <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> for <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a>, S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a></span></code></h3><div class='impl-items'></div><h3 class='impl'><code>impl&lt;T, S&gt; <a class='trait' href='../../../bitflags/__core/fmt/trait.Debug.html' title='bitflags::__core::fmt::Debug'>Debug</a> for <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/fmt/trait.Debug.html' title='bitflags::__core::fmt::Debug'>Debug</a>, S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a></span></code></h3><div class='impl-items'><h4 id='method.fmt' class='method'><code>fn <a href='../../../bitflags/__core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, f: &amp;mut <a class='struct' href='../../../bitflags/__core/fmt/struct.Formatter.html' title='bitflags::__core::fmt::Formatter'>Formatter</a>) -&gt; <a class='enum' href='../../../bitflags/__core/result/enum.Result.html' title='bitflags::__core::result::Result'>Result</a>&lt;<a class='primitive' href='https://doc.rust-lang.org/nightly/bitflags/primitive.tuple.html'>()</a>, <a class='struct' href='../../../bitflags/__core/fmt/struct.Error.html' title='bitflags::__core::fmt::Error'>Error</a>&gt;</code></h4>
</div><h3 class='impl'><code>impl&lt;T, S&gt; <a class='trait' href='../../../bitflags/__core/iter/trait.FromIterator.html' title='bitflags::__core::iter::FromIterator'>FromIterator</a>&lt;T&gt; for <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a>, S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a> + <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a></span></code></h3><div class='impl-items'><h4 id='method.from_iter' class='method'><code>fn <a href='../../../bitflags/__core/iter/trait.FromIterator.html#tymethod.from_iter' class='fnname'>from_iter</a>&lt;I&gt;(iter: I) -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where I: <a class='trait' href='../../../bitflags/__core/iter/trait.IntoIterator.html' title='bitflags::__core::iter::IntoIterator'>IntoIterator</a>&lt;Item=T&gt;</span></code></h4>
</div><h3 class='impl'><code>impl&lt;T, S&gt; <a class='trait' href='../../../bitflags/__core/iter/trait.Extend.html' title='bitflags::__core::iter::Extend'>Extend</a>&lt;T&gt; for <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a>, T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a></span></code></h3><div class='impl-items'><h4 id='method.extend' class='method'><code>fn <a href='../../../bitflags/__core/iter/trait.Extend.html#tymethod.extend' class='fnname'>extend</a>&lt;I&gt;(&amp;mut self, iter: I) <span class='where'>where I: <a class='trait' href='../../../bitflags/__core/iter/trait.IntoIterator.html' title='bitflags::__core::iter::IntoIterator'>IntoIterator</a>&lt;Item=T&gt;</span></code></h4>
</div><h3 class='impl'><code>impl&lt;'a, T, S&gt; <a class='trait' href='../../../bitflags/__core/iter/trait.Extend.html' title='bitflags::__core::iter::Extend'>Extend</a>&lt;&amp;'a T&gt; for <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a>, T: 'a + <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/marker/trait.Copy.html' title='bitflags::__core::marker::Copy'>Copy</a></span></code><span class="since">1.4.0</span></h3><div class='impl-items'><h4 id='method.extend-1' class='method'><code>fn <a href='../../../bitflags/__core/iter/trait.Extend.html#tymethod.extend' class='fnname'>extend</a>&lt;I&gt;(&amp;mut self, iter: I) <span class='where'>where I: <a class='trait' href='../../../bitflags/__core/iter/trait.IntoIterator.html' title='bitflags::__core::iter::IntoIterator'>IntoIterator</a>&lt;Item=&amp;'a T&gt;</span></code></h4>
</div><h3 class='impl'><code>impl&lt;T, S&gt; <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a> for <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a> + <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a>, T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a></span></code></h3><div class='impl-items'><h4 id='method.default' class='method'><code>fn <a href='../../../bitflags/__core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
</div><h3 class='impl'><code>impl&lt;'a, 'b, T, S&gt; <a class='trait' href='../../../bitflags/__core/ops/trait.BitOr.html' title='bitflags::__core::ops::BitOr'>BitOr</a>&lt;&amp;'b <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;&gt; for &amp;'a <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a> + <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a>, T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a></span></code></h3><div class='impl-items'><h4 id='associatedtype.Output' class='type'><code>type <a href='../../../bitflags/__core/ops/trait.BitOr.html#associatedtype.Output' class='type'>Output</a> = <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
<h4 id='method.bitor' class='method'><code>fn <a href='../../../bitflags/__core/ops/trait.BitOr.html#tymethod.bitor' class='fnname'>bitor</a>(self, rhs: &amp;<a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
<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>
<h1 id='examples-22' class='section-header'><a href='#examples-22'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>into_iter</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>b</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>3</span>, <span class='number'>4</span>, <span class='number'>5</span>].<span class='ident'>into_iter</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='kw-2'>&amp;</span><span class='ident'>a</span> <span class='op'>|</span> <span class='kw-2'>&amp;</span><span class='ident'>b</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>i</span> <span class='op'>=</span> <span class='number'>0</span>;
<span class='kw'>let</span> <span class='ident'>expected</span> <span class='op'>=</span> [<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> <span class='ident'>x</span> <span class='kw'>in</span> <span class='kw-2'>&amp;</span><span class='ident'>set</span> {
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>expected</span>.<span class='ident'>contains</span>(<span class='ident'>x</span>));
<span class='ident'>i</span> <span class='op'>+=</span> <span class='number'>1</span>;
}
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>i</span>, <span class='ident'>expected</span>.<span class='ident'>len</span>());</pre>
</div></div><h3 class='impl'><code>impl&lt;'a, 'b, T, S&gt; <a class='trait' href='../../../bitflags/__core/ops/trait.BitAnd.html' title='bitflags::__core::ops::BitAnd'>BitAnd</a>&lt;&amp;'b <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;&gt; for &amp;'a <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a> + <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a>, T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a></span></code></h3><div class='impl-items'><h4 id='associatedtype.Output-1' class='type'><code>type <a href='../../../bitflags/__core/ops/trait.BitAnd.html#associatedtype.Output' class='type'>Output</a> = <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
<h4 id='method.bitand' class='method'><code>fn <a href='../../../bitflags/__core/ops/trait.BitAnd.html#tymethod.bitand' class='fnname'>bitand</a>(self, rhs: &amp;<a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
<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>
<h1 id='examples-23' class='section-header'><a href='#examples-23'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>into_iter</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>b</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>2</span>, <span class='number'>3</span>, <span class='number'>4</span>].<span class='ident'>into_iter</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='kw-2'>&amp;</span><span class='ident'>a</span> <span class='kw-2'>&amp;</span> <span class='kw-2'>&amp;</span><span class='ident'>b</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>i</span> <span class='op'>=</span> <span class='number'>0</span>;
<span class='kw'>let</span> <span class='ident'>expected</span> <span class='op'>=</span> [<span class='number'>2</span>, <span class='number'>3</span>];
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='kw-2'>&amp;</span><span class='ident'>set</span> {
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>expected</span>.<span class='ident'>contains</span>(<span class='ident'>x</span>));
<span class='ident'>i</span> <span class='op'>+=</span> <span class='number'>1</span>;
}
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>i</span>, <span class='ident'>expected</span>.<span class='ident'>len</span>());</pre>
</div></div><h3 class='impl'><code>impl&lt;'a, 'b, T, S&gt; <a class='trait' href='../../../bitflags/__core/ops/trait.BitXor.html' title='bitflags::__core::ops::BitXor'>BitXor</a>&lt;&amp;'b <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;&gt; for &amp;'a <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a> + <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a>, T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a></span></code></h3><div class='impl-items'><h4 id='associatedtype.Output-2' class='type'><code>type <a href='../../../bitflags/__core/ops/trait.BitXor.html#associatedtype.Output' class='type'>Output</a> = <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
<h4 id='method.bitxor' class='method'><code>fn <a href='../../../bitflags/__core/ops/trait.BitXor.html#tymethod.bitxor' class='fnname'>bitxor</a>(self, rhs: &amp;<a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
<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>
<h1 id='examples-24' class='section-header'><a href='#examples-24'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>into_iter</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>b</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>3</span>, <span class='number'>4</span>, <span class='number'>5</span>].<span class='ident'>into_iter</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='kw-2'>&amp;</span><span class='ident'>a</span> <span class='op'>^</span> <span class='kw-2'>&amp;</span><span class='ident'>b</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>i</span> <span class='op'>=</span> <span class='number'>0</span>;
<span class='kw'>let</span> <span class='ident'>expected</span> <span class='op'>=</span> [<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> <span class='ident'>x</span> <span class='kw'>in</span> <span class='kw-2'>&amp;</span><span class='ident'>set</span> {
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>expected</span>.<span class='ident'>contains</span>(<span class='ident'>x</span>));
<span class='ident'>i</span> <span class='op'>+=</span> <span class='number'>1</span>;
}
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>i</span>, <span class='ident'>expected</span>.<span class='ident'>len</span>());</pre>
</div></div><h3 class='impl'><code>impl&lt;'a, 'b, T, S&gt; <a class='trait' href='../../../bitflags/__core/ops/trait.Sub.html' title='bitflags::__core::ops::Sub'>Sub</a>&lt;&amp;'b <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;&gt; for &amp;'a <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a> + <a class='trait' href='../../../bitflags/__core/default/trait.Default.html' title='bitflags::__core::default::Default'>Default</a>, T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a> + <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a></span></code></h3><div class='impl-items'><h4 id='associatedtype.Output-3' class='type'><code>type <a href='../../../bitflags/__core/ops/trait.Sub.html#associatedtype.Output' class='type'>Output</a> = <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
<h4 id='method.sub' class='method'><code>fn <a href='../../../bitflags/__core/ops/trait.Sub.html#tymethod.sub' class='fnname'>sub</a>(self, rhs: &amp;<a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;) -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
<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>
<h1 id='examples-25' class='section-header'><a href='#examples-25'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='ident'>a</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>1</span>, <span class='number'>2</span>, <span class='number'>3</span>].<span class='ident'>into_iter</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>b</span>: <span class='ident'>HashSet</span><span class='op'>&lt;</span>_<span class='op'>&gt;</span> <span class='op'>=</span> <span class='macro'>vec</span><span class='macro'>!</span>[<span class='number'>3</span>, <span class='number'>4</span>, <span class='number'>5</span>].<span class='ident'>into_iter</span>().<span class='ident'>collect</span>();
<span class='kw'>let</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='kw-2'>&amp;</span><span class='ident'>a</span> <span class='op'>-</span> <span class='kw-2'>&amp;</span><span class='ident'>b</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>i</span> <span class='op'>=</span> <span class='number'>0</span>;
<span class='kw'>let</span> <span class='ident'>expected</span> <span class='op'>=</span> [<span class='number'>1</span>, <span class='number'>2</span>];
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='kw-2'>&amp;</span><span class='ident'>set</span> {
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>expected</span>.<span class='ident'>contains</span>(<span class='ident'>x</span>));
<span class='ident'>i</span> <span class='op'>+=</span> <span class='number'>1</span>;
}
<span class='macro'>assert_eq</span><span class='macro'>!</span>(<span class='ident'>i</span>, <span class='ident'>expected</span>.<span class='ident'>len</span>());</pre>
</div></div><h3 class='impl'><code>impl&lt;'a, T, S&gt; <a class='trait' href='../../../bitflags/__core/iter/trait.IntoIterator.html' title='bitflags::__core::iter::IntoIterator'>IntoIterator</a> for &amp;'a <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a>, T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a></span></code></h3><div class='impl-items'><h4 id='associatedtype.Item' class='type'><code>type <a href='../../../bitflags/__core/iter/trait.IntoIterator.html#associatedtype.Item' class='type'>Item</a> = &amp;'a T</code></h4>
<h4 id='associatedtype.IntoIter' class='type'><code>type <a href='../../../bitflags/__core/iter/trait.IntoIterator.html#associatedtype.IntoIter' class='type'>IntoIter</a> = <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.Iter.html' title='bitflags::__core::collections::hash_set::Iter'>Iter</a>&lt;'a, T&gt;</code></h4>
<h4 id='method.into_iter' class='method'><code>fn <a href='../../../bitflags/__core/iter/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -&gt; <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.Iter.html' title='bitflags::__core::collections::hash_set::Iter'>Iter</a>&lt;'a, T&gt;</code></h4>
</div><h3 class='impl'><code>impl&lt;T, S&gt; <a class='trait' href='../../../bitflags/__core/iter/trait.IntoIterator.html' title='bitflags::__core::iter::IntoIterator'>IntoIterator</a> for <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/cmp/trait.Eq.html' title='bitflags::__core::cmp::Eq'>Eq</a> + <a class='trait' href='../../../bitflags/__core/hash/trait.Hash.html' title='bitflags::__core::hash::Hash'>Hash</a>, S: <a class='trait' href='../../../bitflags/__core/hash/trait.BuildHasher.html' title='bitflags::__core::hash::BuildHasher'>BuildHasher</a></span></code></h3><div class='impl-items'><h4 id='associatedtype.Item-1' class='type'><code>type <a href='../../../bitflags/__core/iter/trait.IntoIterator.html#associatedtype.Item' class='type'>Item</a> = T</code></h4>
<h4 id='associatedtype.IntoIter-1' class='type'><code>type <a href='../../../bitflags/__core/iter/trait.IntoIterator.html#associatedtype.IntoIter' class='type'>IntoIter</a> = <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.IntoIter.html' title='bitflags::__core::collections::hash_set::IntoIter'>IntoIter</a>&lt;T&gt;</code></h4>
<h4 id='method.into_iter-1' class='method'><code>fn <a href='../../../bitflags/__core/iter/trait.IntoIterator.html#tymethod.into_iter' class='fnname'>into_iter</a>(self) -&gt; <a class='struct' href='../../../bitflags/__core/collections/hash_set/struct.IntoIter.html' title='bitflags::__core::collections::hash_set::IntoIter'>IntoIter</a>&lt;T&gt;</code></h4>
<div class='docblock'><p>Creates a consuming iterator, that is, one that moves each value out
of the set in arbitrary order. The set cannot be used after calling
this.</p>
<h1 id='examples-26' class='section-header'><a href='#examples-26'>Examples</a></h1>
<pre class='rust rust-example-rendered'>
<span class='kw'>use</span> <span class='ident'>std</span>::<span class='ident'>collections</span>::<span class='ident'>HashSet</span>;
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>set</span> <span class='op'>=</span> <span class='ident'>HashSet</span>::<span class='ident'>new</span>();
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='string'>&quot;a&quot;</span>.<span class='ident'>to_string</span>());
<span class='ident'>set</span>.<span class='ident'>insert</span>(<span class='string'>&quot;b&quot;</span>.<span class='ident'>to_string</span>());
<span class='comment'>// Not possible to collect to a Vec&lt;String&gt; with a regular `.iter()`.</span>
<span class='kw'>let</span> <span class='ident'>v</span>: <span class='ident'>Vec</span><span class='op'>&lt;</span><span class='ident'>String</span><span class='op'>&gt;</span> <span class='op'>=</span> <span class='ident'>set</span>.<span class='ident'>into_iter</span>().<span class='ident'>collect</span>();
<span class='comment'>// Will print in an arbitrary order.</span>
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='kw-2'>&amp;</span><span class='ident'>v</span> {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>&quot;{}&quot;</span>, <span class='ident'>x</span>);
}</pre>
</div></div><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><code>impl&lt;T, S&gt; <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a> for <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt; <span class='where'>where T: <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a>, S: <a class='trait' href='../../../bitflags/__core/clone/trait.Clone.html' title='bitflags::__core::clone::Clone'>Clone</a></span></code></h3><div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='../../../bitflags/__core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class='struct' href='../../../bitflags/__core/collections/struct.HashSet.html' title='bitflags::__core::collections::HashSet'>HashSet</a>&lt;T, S&gt;</code></h4>
<h4 id='method.clone_from' class='method'><code>fn <a href='../../../bitflags/__core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code></h4>
</div></section>
<section id='search' class="content hidden"></section>
<section class="footer"></section>
<aside id="help" class="hidden">
<div>
<h1 class="hidden">Help</h1>
<div class="shortcuts">
<h2>Keyboard Shortcuts</h2>
<dl>
<dt>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</dd>
</dl>
</div>
<div class="infos">
<h2>Search Tricks</h2>
<p>
Prefix searches with a type followed by a colon (e.g.
<code>fn:</code>) to restrict the search to a given type.
</p>
<p>
Accepted types are: <code>fn</code>, <code>mod</code>,
<code>struct</code>, <code>enum</code>,
<code>trait</code>, <code>type</code>, <code>macro</code>,
and <code>const</code>.
</p>
<p>
Search functions by type signature (e.g.
<code>vec -> usize</code> or <code>* -> vec</code>)
</p>
</div>
</div>
</aside>
<script>
window.rootPath = "../../../";
window.currentCrate = "bitflags";
window.playgroundUrl = "";
</script>
<script src="../../../jquery.js"></script>
<script src="../../../main.js"></script>
<script defer src="../../../search-index.js"></script>
</body>
</html>