<!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 `bit_set` crate.">
<meta name="keywords" content="rust, rustlang, rust-lang, bit_set">
<title>bit_set - Rust</title>
<link rel="stylesheet" type="text/css" href="../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../main.css">
</head>
<body class="rustdoc">
<nav class="sidebar">
<p class='location'></p><script>window.sidebarCurrent = {name: 'bit_set', ty: 'mod', relpath: '../'};</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 mod">
<h1 class='fqn'><span class='in-band'>Crate <a class='mod' href=''>bit_set</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'>−</span>]
</a>
</span><a id='src-0' class='srclink' href='../src/bit_set/lib.rs.html#11-1462' title='goto source code'>[src]</a></span></h1>
<div class='docblock'><p>An implementation of a set using a bit vector as an underlying
representation for holding unsigned numerical elements.</p>
<p>It should also be noted that the amount of storage necessary for holding a
set of objects is proportional to the maximum of the objects when viewed
as a <code>usize</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'>bit_set</span>::<span class='ident'>BitSet</span>;
<span class='comment'>// It's a regular set</span>
<span class='kw'>let</span> <span class='kw-2'>mut</span> <span class='ident'>s</span> <span class='op'>=</span> <span class='ident'>BitSet</span>::<span class='ident'>new</span>();
<span class='ident'>s</span>.<span class='ident'>insert</span>(<span class='number'>0</span>);
<span class='ident'>s</span>.<span class='ident'>insert</span>(<span class='number'>3</span>);
<span class='ident'>s</span>.<span class='ident'>insert</span>(<span class='number'>7</span>);
<span class='ident'>s</span>.<span class='ident'>remove</span>(<span class='kw-2'>&</span><span class='number'>7</span>);
<span class='kw'>if</span> <span class='op'>!</span><span class='ident'>s</span>.<span class='ident'>contains</span>(<span class='kw-2'>&</span><span class='number'>7</span>) {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"There is no 7"</span>);
}
<span class='comment'>// Can initialize from a `BitVec`</span>
<span class='kw'>let</span> <span class='ident'>other</span> <span class='op'>=</span> <span class='ident'>BitSet</span>::<span class='ident'>from_bytes</span>(<span class='kw-2'>&</span>[<span class='number'>0b11010000</span>]);
<span class='ident'>s</span>.<span class='ident'>union_with</span>(<span class='kw-2'>&</span><span class='ident'>other</span>);
<span class='comment'>// Print 0, 1, 3 in some order</span>
<span class='kw'>for</span> <span class='ident'>x</span> <span class='kw'>in</span> <span class='ident'>s</span>.<span class='ident'>iter</span>() {
<span class='macro'>println</span><span class='macro'>!</span>(<span class='string'>"{}"</span>, <span class='ident'>x</span>);
}
<span class='comment'>// Can convert back to a `BitVec`</span>
<span class='kw'>let</span> <span class='ident'>bv</span> <span class='op'>=</span> <span class='ident'>s</span>.<span class='ident'>into_bit_vec</span>();
<span class='macro'>assert</span><span class='macro'>!</span>(<span class='ident'>bv</span>[<span class='number'>3</span>]);</pre>
</div><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
<table>
<tr class=' module-item'>
<td><a class='struct' href='struct.BitSet.html'
title='bit_set::BitSet'>BitSet</a></td>
<td class='docblock short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.Difference.html'
title='bit_set::Difference'>Difference</a></td>
<td class='docblock short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.Intersection.html'
title='bit_set::Intersection'>Intersection</a></td>
<td class='docblock short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.Iter.html'
title='bit_set::Iter'>Iter</a></td>
<td class='docblock short'>
<p>An iterator for <code>BitSet</code>.</p>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.SymmetricDifference.html'
title='bit_set::SymmetricDifference'>SymmetricDifference</a></td>
<td class='docblock short'>
</td>
</tr>
<tr class=' module-item'>
<td><a class='struct' href='struct.Union.html'
title='bit_set::Union'>Union</a></td>
<td class='docblock short'>
</td>
</tr></table></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>⇤</dt>
<dd>Move up in search results</dd>
<dt>⇥</dt>
<dd>Move down in search results</dd>
<dt>⏎</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 = "bit_set";
window.playgroundUrl = "";
</script>
<script src="../jquery.js"></script>
<script src="../main.js"></script>
<script defer src="../search-index.js"></script>
</body>
</html>