blob: 613690bfff7c7e87a8cecd1825b738ea7c77877b [file] [log] [blame]
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A hash map implemented with quadratic probing and SIMD lookup."><meta name="keywords" content="rust, rustlang, rust-lang, hash_map"><title>hashbrown::hash_map - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc mod"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../../hashbrown/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../hashbrown/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">Module hash_map</a></h2><div class="sidebar-elems"><section><ul class="block"><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li></ul></section></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Module <a href="../index.html">hashbrown</a>::<wbr><a class="mod" href="#">hash_map</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/hashbrown/lib.rs.html#85">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A hash map implemented with quadratic probing and SIMD lookup.</p>
</div></details><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Drain.html" title="hashbrown::hash_map::Drain struct">Drain</a></div><div class="item-right docblock-short">A draining iterator over the entries of a <code>HashMap</code> in arbitrary
order. The iterator element type is <code>(K, V)</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.DrainFilter.html" title="hashbrown::hash_map::DrainFilter struct">DrainFilter</a></div><div class="item-right docblock-short">A draining iterator over entries of a <code>HashMap</code> which don’t satisfy the predicate
<code>f(&amp;k, &amp;mut v)</code> in arbitrary order. The iterator element type is <code>(K, V)</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.HashMap.html" title="hashbrown::hash_map::HashMap struct">HashMap</a></div><div class="item-right docblock-short">A hash map implemented with quadratic probing and SIMD lookup.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntoIter.html" title="hashbrown::hash_map::IntoIter struct">IntoIter</a></div><div class="item-right docblock-short">An owning iterator over the entries of a <code>HashMap</code> in arbitrary order.
The iterator element type is <code>(K, V)</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntoKeys.html" title="hashbrown::hash_map::IntoKeys struct">IntoKeys</a></div><div class="item-right docblock-short">An owning iterator over the keys of a <code>HashMap</code> in arbitrary order.
The iterator element type is <code>K</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IntoValues.html" title="hashbrown::hash_map::IntoValues struct">IntoValues</a></div><div class="item-right docblock-short">An owning iterator over the values of a <code>HashMap</code> in arbitrary order.
The iterator element type is <code>V</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Iter.html" title="hashbrown::hash_map::Iter struct">Iter</a></div><div class="item-right docblock-short">An iterator over the entries of a <code>HashMap</code> in arbitrary order.
The iterator element type is <code>(&amp;'a K, &amp;'a V)</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.IterMut.html" title="hashbrown::hash_map::IterMut struct">IterMut</a></div><div class="item-right docblock-short">A mutable iterator over the entries of a <code>HashMap</code> in arbitrary order.
The iterator element type is <code>(&amp;'a K, &amp;'a mut V)</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Keys.html" title="hashbrown::hash_map::Keys struct">Keys</a></div><div class="item-right docblock-short">An iterator over the keys of a <code>HashMap</code> in arbitrary order.
The iterator element type is <code>&amp;'a K</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OccupiedEntry.html" title="hashbrown::hash_map::OccupiedEntry struct">OccupiedEntry</a></div><div class="item-right docblock-short">A view into an occupied entry in a <code>HashMap</code>.
It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OccupiedEntryRef.html" title="hashbrown::hash_map::OccupiedEntryRef struct">OccupiedEntryRef</a></div><div class="item-right docblock-short">A view into an occupied entry in a <code>HashMap</code>.
It is part of the <a href="enum.EntryRef.html"><code>EntryRef</code></a> enum.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OccupiedError.html" title="hashbrown::hash_map::OccupiedError struct">OccupiedError</a></div><div class="item-right docblock-short">The error returned by <a href="struct.HashMap.html#method.try_insert"><code>try_insert</code></a> when the key already exists.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RawEntryBuilder.html" title="hashbrown::hash_map::RawEntryBuilder struct">RawEntryBuilder</a></div><div class="item-right docblock-short">A builder for computing where in a <a href="struct.HashMap.html" title="HashMap"><code>HashMap</code></a> a key-value pair would be stored.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RawEntryBuilderMut.html" title="hashbrown::hash_map::RawEntryBuilderMut struct">RawEntryBuilderMut</a></div><div class="item-right docblock-short">A builder for computing where in a <a href="struct.HashMap.html" title="HashMap"><code>HashMap</code></a> a key-value pair would be stored.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RawOccupiedEntryMut.html" title="hashbrown::hash_map::RawOccupiedEntryMut struct">RawOccupiedEntryMut</a></div><div class="item-right docblock-short">A view into an occupied entry in a <code>HashMap</code>.
It is part of the <a href="enum.RawEntryMut.html"><code>RawEntryMut</code></a> enum.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.RawVacantEntryMut.html" title="hashbrown::hash_map::RawVacantEntryMut struct">RawVacantEntryMut</a></div><div class="item-right docblock-short">A view into a vacant entry in a <code>HashMap</code>.
It is part of the <a href="enum.RawEntryMut.html"><code>RawEntryMut</code></a> enum.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VacantEntry.html" title="hashbrown::hash_map::VacantEntry struct">VacantEntry</a></div><div class="item-right docblock-short">A view into a vacant entry in a <code>HashMap</code>.
It is part of the <a href="enum.Entry.html"><code>Entry</code></a> enum.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.VacantEntryRef.html" title="hashbrown::hash_map::VacantEntryRef struct">VacantEntryRef</a></div><div class="item-right docblock-short">A view into a vacant entry in a <code>HashMap</code>.
It is part of the <a href="enum.EntryRef.html"><code>EntryRef</code></a> enum.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Values.html" title="hashbrown::hash_map::Values struct">Values</a></div><div class="item-right docblock-short">An iterator over the values of a <code>HashMap</code> in arbitrary order.
The iterator element type is <code>&amp;'a V</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.ValuesMut.html" title="hashbrown::hash_map::ValuesMut struct">ValuesMut</a></div><div class="item-right docblock-short">A mutable iterator over the values of a <code>HashMap</code> in arbitrary order.
The iterator element type is <code>&amp;'a mut V</code>.</div></div></div><h2 id="enums" class="small-section-header"><a href="#enums">Enums</a></h2><div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.DefaultHashBuilder.html" title="hashbrown::hash_map::DefaultHashBuilder enum">DefaultHashBuilder</a></div><div class="item-right docblock-short">Dummy default hasher for <code>HashMap</code>.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.Entry.html" title="hashbrown::hash_map::Entry enum">Entry</a></div><div class="item-right docblock-short">A view into a single entry in a map, which may either be vacant or occupied.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.EntryRef.html" title="hashbrown::hash_map::EntryRef enum">EntryRef</a></div><div class="item-right docblock-short">A view into a single entry in a map, which may either be vacant or occupied,
with any borrowed form of the map’s key type.</div></div><div class="item-row"><div class="item-left module-item"><a class="enum" href="enum.RawEntryMut.html" title="hashbrown::hash_map::RawEntryMut enum">RawEntryMut</a></div><div class="item-right docblock-short">A view into a single entry in a map, which may either be vacant or occupied.</div></div></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="hashbrown" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>