| <!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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/hashbrown-0.12.3/src/lib.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>lib.rs - source</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="../../source-script.js"></script><script defer src="../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../hashbrown/index.html"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| </pre><pre class="rust"><code><span class="doccomment">//! This crate is a Rust port of Google's high-performance [SwissTable] hash |
| //! map, adapted to make it a drop-in replacement for Rust's standard `HashMap` |
| //! and `HashSet` types. |
| //! |
| //! The original C++ version of [SwissTable] can be found [here], and this |
| //! [CppCon talk] gives an overview of how the algorithm works. |
| //! |
| //! [SwissTable]: https://abseil.io/blog/20180927-swisstables |
| //! [here]: https://github.com/abseil/abseil-cpp/blob/master/absl/container/internal/raw_hash_set.h |
| //! [CppCon talk]: https://www.youtube.com/watch?v=ncHmEUmJZf4 |
| |
| </span><span class="attribute">#![no_std] |
| #![cfg_attr( |
| feature = <span class="string">"nightly"</span>, |
| feature( |
| test, |
| core_intrinsics, |
| dropck_eyepatch, |
| min_specialization, |
| extend_one, |
| allocator_api, |
| slice_ptr_get, |
| nonnull_slice_from_raw_parts, |
| maybe_uninit_array_assume_init, |
| build_hasher_simple_hash_one |
| ) |
| )] |
| #![allow( |
| clippy::doc_markdown, |
| clippy::module_name_repetitions, |
| clippy::must_use_candidate, |
| clippy::option_if_let_else, |
| clippy::redundant_else, |
| clippy::manual_map, |
| clippy::missing_safety_doc, |
| clippy::missing_errors_doc |
| )] |
| #![warn(missing_docs)] |
| #![warn(rust_2018_idioms)] |
| |
| #[cfg(test)] |
| #[macro_use] |
| </span><span class="kw">extern crate </span>std; |
| |
| <span class="attribute">#[cfg_attr(test, macro_use)] |
| </span><span class="kw">extern crate </span>alloc; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"nightly"</span>)] |
| #[cfg(doctest)] |
| </span><span class="macro">doc_comment::doctest!</span>(<span class="string">"../README.md"</span>); |
| |
| <span class="attribute">#[macro_use] |
| </span><span class="kw">mod </span>macros; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"raw"</span>)] |
| </span><span class="doccomment">/// Experimental and unsafe `RawTable` API. This module is only available if the |
| /// `raw` feature is enabled. |
| </span><span class="kw">pub mod </span>raw { |
| <span class="comment">// The RawTable API is still experimental and is not properly documented yet. |
| </span><span class="attribute">#[allow(missing_docs)] |
| #[path = <span class="string">"mod.rs"</span>] |
| </span><span class="kw">mod </span>inner; |
| <span class="kw">pub use </span>inner::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"rayon"</span>)] |
| </span><span class="doccomment">/// [rayon]-based parallel iterator types for hash maps. |
| /// You will rarely need to interact with it directly unless you have need |
| /// to name one of the iterator types. |
| /// |
| /// [rayon]: https://docs.rs/rayon/1.0/rayon |
| </span><span class="kw">pub mod </span>rayon { |
| <span class="kw">pub use </span><span class="kw">crate</span>::external_trait_impls::rayon::raw::<span class="kw-2">*</span>; |
| } |
| } |
| <span class="attribute">#[cfg(not(feature = <span class="string">"raw"</span>))] |
| </span><span class="kw">mod </span>raw; |
| |
| <span class="kw">mod </span>external_trait_impls; |
| <span class="kw">mod </span>map; |
| <span class="attribute">#[cfg(feature = <span class="string">"rustc-internal-api"</span>)] |
| </span><span class="kw">mod </span>rustc_entry; |
| <span class="kw">mod </span>scopeguard; |
| <span class="kw">mod </span>set; |
| |
| <span class="kw">pub mod </span>hash_map { |
| <span class="doccomment">//! A hash map implemented with quadratic probing and SIMD lookup. |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::map::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"rustc-internal-api"</span>)] |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::rustc_entry::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"rayon"</span>)] |
| </span><span class="doccomment">/// [rayon]-based parallel iterator types for hash maps. |
| /// You will rarely need to interact with it directly unless you have need |
| /// to name one of the iterator types. |
| /// |
| /// [rayon]: https://docs.rs/rayon/1.0/rayon |
| </span><span class="kw">pub mod </span>rayon { |
| <span class="kw">pub use </span><span class="kw">crate</span>::external_trait_impls::rayon::map::<span class="kw-2">*</span>; |
| } |
| } |
| <span class="kw">pub mod </span>hash_set { |
| <span class="doccomment">//! A hash set implemented as a `HashMap` where the value is `()`. |
| </span><span class="kw">pub use </span><span class="kw">crate</span>::set::<span class="kw-2">*</span>; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"rayon"</span>)] |
| </span><span class="doccomment">/// [rayon]-based parallel iterator types for hash sets. |
| /// You will rarely need to interact with it directly unless you have need |
| /// to name one of the iterator types. |
| /// |
| /// [rayon]: https://docs.rs/rayon/1.0/rayon |
| </span><span class="kw">pub mod </span>rayon { |
| <span class="kw">pub use </span><span class="kw">crate</span>::external_trait_impls::rayon::set::<span class="kw-2">*</span>; |
| } |
| } |
| |
| <span class="kw">pub use </span><span class="kw">crate</span>::map::HashMap; |
| <span class="kw">pub use </span><span class="kw">crate</span>::set::HashSet; |
| |
| <span class="doccomment">/// The error type for `try_reserve` methods. |
| </span><span class="attribute">#[derive(Clone, PartialEq, Eq, Debug)] |
| </span><span class="kw">pub enum </span>TryReserveError { |
| <span class="doccomment">/// Error due to the computed capacity exceeding the collection's maximum |
| /// (usually `isize::MAX` bytes). |
| </span>CapacityOverflow, |
| |
| <span class="doccomment">/// The memory allocator returned an error |
| </span>AllocError { |
| <span class="doccomment">/// The layout of the allocation request that failed. |
| </span>layout: alloc::alloc::Layout, |
| }, |
| } |
| |
| <span class="doccomment">/// Wrapper around `Bump` which allows it to be used as an allocator for |
| /// `HashMap`, `HashSet` and `RawTable`. |
| /// |
| /// `Bump` can be used directly without this wrapper on nightly if you enable |
| /// the `allocator-api` feature of the `bumpalo` crate. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"bumpalo"</span>)] |
| #[derive(Clone, Copy, Debug)] |
| </span><span class="kw">pub struct </span>BumpWrapper<<span class="lifetime">'a</span>>(<span class="kw">pub </span><span class="kw-2">&</span><span class="lifetime">'a </span>bumpalo::Bump); |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"bumpalo"</span>)] |
| #[test] |
| </span><span class="kw">fn </span>test_bumpalo() { |
| <span class="kw">use </span>bumpalo::Bump; |
| <span class="kw">let </span>bump = Bump::new(); |
| <span class="kw">let </span><span class="kw-2">mut </span>map = HashMap::new_in(BumpWrapper(<span class="kw-2">&</span>bump)); |
| map.insert(<span class="number">0</span>, <span class="number">1</span>); |
| } |
| </code></pre></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> |
