blob: 52720045709ddd3c5d7c68052f201d996093088a [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="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/ahash-0.7.6/src/random_state.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>random_state.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="../../ahash/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="../../ahash/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>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
<span id="257">257</span>
<span id="258">258</span>
<span id="259">259</span>
<span id="260">260</span>
<span id="261">261</span>
<span id="262">262</span>
<span id="263">263</span>
<span id="264">264</span>
<span id="265">265</span>
<span id="266">266</span>
<span id="267">267</span>
<span id="268">268</span>
<span id="269">269</span>
<span id="270">270</span>
<span id="271">271</span>
<span id="272">272</span>
<span id="273">273</span>
<span id="274">274</span>
<span id="275">275</span>
<span id="276">276</span>
<span id="277">277</span>
<span id="278">278</span>
<span id="279">279</span>
<span id="280">280</span>
<span id="281">281</span>
<span id="282">282</span>
<span id="283">283</span>
<span id="284">284</span>
<span id="285">285</span>
<span id="286">286</span>
<span id="287">287</span>
<span id="288">288</span>
<span id="289">289</span>
<span id="290">290</span>
<span id="291">291</span>
<span id="292">292</span>
<span id="293">293</span>
<span id="294">294</span>
<span id="295">295</span>
<span id="296">296</span>
<span id="297">297</span>
<span id="298">298</span>
<span id="299">299</span>
<span id="300">300</span>
<span id="301">301</span>
<span id="302">302</span>
<span id="303">303</span>
<span id="304">304</span>
<span id="305">305</span>
<span id="306">306</span>
<span id="307">307</span>
<span id="308">308</span>
<span id="309">309</span>
<span id="310">310</span>
<span id="311">311</span>
<span id="312">312</span>
<span id="313">313</span>
<span id="314">314</span>
<span id="315">315</span>
<span id="316">316</span>
<span id="317">317</span>
<span id="318">318</span>
<span id="319">319</span>
<span id="320">320</span>
<span id="321">321</span>
<span id="322">322</span>
<span id="323">323</span>
<span id="324">324</span>
<span id="325">325</span>
<span id="326">326</span>
<span id="327">327</span>
<span id="328">328</span>
<span id="329">329</span>
<span id="330">330</span>
<span id="331">331</span>
<span id="332">332</span>
<span id="333">333</span>
<span id="334">334</span>
<span id="335">335</span>
<span id="336">336</span>
<span id="337">337</span>
<span id="338">338</span>
<span id="339">339</span>
<span id="340">340</span>
<span id="341">341</span>
<span id="342">342</span>
<span id="343">343</span>
<span id="344">344</span>
<span id="345">345</span>
<span id="346">346</span>
<span id="347">347</span>
<span id="348">348</span>
<span id="349">349</span>
<span id="350">350</span>
<span id="351">351</span>
<span id="352">352</span>
<span id="353">353</span>
<span id="354">354</span>
<span id="355">355</span>
<span id="356">356</span>
<span id="357">357</span>
<span id="358">358</span>
</pre><pre class="rust"><code><span class="attribute">#[cfg(all(feature = <span class="string">&quot;runtime-rng&quot;</span>, not(all(feature = <span class="string">&quot;compile-time-rng&quot;</span>, test))))]
</span><span class="kw">use </span><span class="kw">crate</span>::convert::Convert;
<span class="attribute">#[cfg(feature = <span class="string">&quot;specialize&quot;</span>)]
</span><span class="kw">use </span><span class="kw">crate</span>::BuildHasherExt;
<span class="attribute">#[cfg(any(
all(any(target_arch = <span class="string">&quot;x86&quot;</span>, target_arch = <span class="string">&quot;x86_64&quot;</span>), target_feature = <span class="string">&quot;aes&quot;</span>, not(miri)),
all(any(target_arch = <span class="string">&quot;arm&quot;</span>, target_arch = <span class="string">&quot;aarch64&quot;</span>), target_feature = <span class="string">&quot;crypto&quot;</span>, not(miri), feature = <span class="string">&quot;stdsimd&quot;</span>)
))]
</span><span class="kw">pub use </span><span class="kw">crate</span>::aes_hash::<span class="kw-2">*</span>;
<span class="attribute">#[cfg(not(any(
all(any(target_arch = <span class="string">&quot;x86&quot;</span>, target_arch = <span class="string">&quot;x86_64&quot;</span>), target_feature = <span class="string">&quot;aes&quot;</span>, not(miri)),
all(any(target_arch = <span class="string">&quot;arm&quot;</span>, target_arch = <span class="string">&quot;aarch64&quot;</span>), target_feature = <span class="string">&quot;crypto&quot;</span>, not(miri), feature = <span class="string">&quot;stdsimd&quot;</span>)
)))]
</span><span class="kw">pub use </span><span class="kw">crate</span>::fallback_hash::<span class="kw-2">*</span>;
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;compile-time-rng&quot;</span>, any(not(feature = <span class="string">&quot;runtime-rng&quot;</span>), test)))]
</span><span class="kw">use </span>const_random::const_random;
<span class="kw">use </span>core::any::{Any, TypeId};
<span class="kw">use </span>core::fmt;
<span class="kw">use </span>core::hash::BuildHasher;
<span class="attribute">#[cfg(feature = <span class="string">&quot;specialize&quot;</span>)]
</span><span class="kw">use </span>core::hash::Hash;
<span class="kw">use </span>core::hash::Hasher;
<span class="attribute">#[cfg(not(feature = <span class="string">&quot;std&quot;</span>))]
</span><span class="kw">extern crate </span>alloc;
<span class="attribute">#[cfg(feature = <span class="string">&quot;std&quot;</span>)]
</span><span class="kw">extern crate </span>std <span class="kw">as </span>alloc;
<span class="kw">use </span>alloc::boxed::Box;
<span class="kw">use </span>core::sync::atomic::{AtomicUsize, Ordering};
<span class="attribute">#[cfg(not(all(target_arch = <span class="string">&quot;arm&quot;</span>, target_os = <span class="string">&quot;none&quot;</span>)))]
</span><span class="kw">use </span>once_cell::race::OnceBox;
<span class="attribute">#[cfg(any(
all(any(target_arch = <span class="string">&quot;x86&quot;</span>, target_arch = <span class="string">&quot;x86_64&quot;</span>), target_feature = <span class="string">&quot;aes&quot;</span>, not(miri)),
all(any(target_arch = <span class="string">&quot;arm&quot;</span>, target_arch = <span class="string">&quot;aarch64&quot;</span>), target_feature = <span class="string">&quot;crypto&quot;</span>, not(miri), feature = <span class="string">&quot;stdsimd&quot;</span>)
))]
</span><span class="kw">use </span><span class="kw">crate</span>::aes_hash::<span class="kw-2">*</span>;
<span class="attribute">#[cfg(not(any(
all(any(target_arch = <span class="string">&quot;x86&quot;</span>, target_arch = <span class="string">&quot;x86_64&quot;</span>), target_feature = <span class="string">&quot;aes&quot;</span>, not(miri)),
all(any(target_arch = <span class="string">&quot;arm&quot;</span>, target_arch = <span class="string">&quot;aarch64&quot;</span>), target_feature = <span class="string">&quot;crypto&quot;</span>, not(miri), feature = <span class="string">&quot;stdsimd&quot;</span>)
)))]
</span><span class="kw">use </span><span class="kw">crate</span>::fallback_hash::<span class="kw-2">*</span>;
<span class="attribute">#[cfg(not(all(target_arch = <span class="string">&quot;arm&quot;</span>, target_os = <span class="string">&quot;none&quot;</span>)))]
</span><span class="kw">static </span>RAND_SOURCE: OnceBox&lt;Box&lt;<span class="kw">dyn </span>RandomSource + Send + Sync&gt;&gt; = OnceBox::new();
<span class="doccomment">/// A supplier of Randomness used for different hashers.
/// See [RandomState.set_random_source].
</span><span class="kw">pub trait </span>RandomSource {
<span class="kw">fn </span>get_fixed_seeds(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>[[u64; <span class="number">4</span>]; <span class="number">2</span>];
<span class="kw">fn </span>gen_hasher_seed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize;
}
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>PI: [u64; <span class="number">4</span>] = [
<span class="number">0x243f_6a88_85a3_08d3</span>,
<span class="number">0x1319_8a2e_0370_7344</span>,
<span class="number">0xa409_3822_299f_31d0</span>,
<span class="number">0x082e_fa98_ec4e_6c89</span>,
];
<span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">const </span>PI2: [u64; <span class="number">4</span>] = [
<span class="number">0x4528_21e6_38d0_1377</span>,
<span class="number">0xbe54_66cf_34e9_0c6c</span>,
<span class="number">0xc0ac_29b7_c97c_50dd</span>,
<span class="number">0x3f84_d5b5_b547_0917</span>,
];
<span class="kw">struct </span>DefaultRandomSource {
counter: AtomicUsize,
}
<span class="kw">impl </span>DefaultRandomSource {
<span class="kw">fn </span>new() -&gt; DefaultRandomSource {
DefaultRandomSource {
counter: AtomicUsize::new(<span class="kw-2">&amp;</span>PI <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>usize),
}
}
<span class="kw">const fn </span>default() -&gt; DefaultRandomSource {
DefaultRandomSource {
counter: AtomicUsize::new(PI[<span class="number">3</span>] <span class="kw">as </span>usize),
}
}
}
<span class="kw">impl </span>RandomSource <span class="kw">for </span>DefaultRandomSource {
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;runtime-rng&quot;</span>, not(all(feature = <span class="string">&quot;compile-time-rng&quot;</span>, test))))]
</span><span class="kw">fn </span>get_fixed_seeds(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>[[u64; <span class="number">4</span>]; <span class="number">2</span>] {
<span class="kw">static </span>SEEDS: OnceBox&lt;[[u64; <span class="number">4</span>]; <span class="number">2</span>]&gt; = OnceBox::new();
SEEDS.get_or_init(|| {
<span class="kw">let </span><span class="kw-2">mut </span>result: [u8; <span class="number">64</span>] = [<span class="number">0</span>; <span class="number">64</span>];
getrandom::getrandom(<span class="kw-2">&amp;mut </span>result).expect(<span class="string">&quot;getrandom::getrandom() failed.&quot;</span>);
Box::new(result.convert())
})
}
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;compile-time-rng&quot;</span>, any(not(feature = <span class="string">&quot;runtime-rng&quot;</span>), test)))]
</span><span class="kw">fn </span>get_fixed_seeds(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>[[u64; <span class="number">4</span>]; <span class="number">2</span>] {
<span class="kw">const </span>RAND: [[u64; <span class="number">4</span>]; <span class="number">2</span>] = [
[
<span class="macro">const_random!</span>(u64),
<span class="macro">const_random!</span>(u64),
<span class="macro">const_random!</span>(u64),
<span class="macro">const_random!</span>(u64),
], [
<span class="macro">const_random!</span>(u64),
<span class="macro">const_random!</span>(u64),
<span class="macro">const_random!</span>(u64),
<span class="macro">const_random!</span>(u64),
]
];
<span class="kw-2">&amp;</span>RAND
}
<span class="attribute">#[cfg(all(not(feature = <span class="string">&quot;runtime-rng&quot;</span>), not(feature = <span class="string">&quot;compile-time-rng&quot;</span>)))]
</span><span class="kw">fn </span>get_fixed_seeds(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span>[[u64; <span class="number">4</span>]; <span class="number">2</span>] {
<span class="kw-2">&amp;</span>[PI, PI2]
}
<span class="attribute">#[cfg(not(all(target_arch = <span class="string">&quot;arm&quot;</span>, target_os = <span class="string">&quot;none&quot;</span>)))]
</span><span class="kw">fn </span>gen_hasher_seed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="kw">let </span>stack = <span class="self">self </span><span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>usize;
<span class="self">self</span>.counter.fetch_add(stack, Ordering::Relaxed)
}
<span class="attribute">#[cfg(all(target_arch = <span class="string">&quot;arm&quot;</span>, target_os = <span class="string">&quot;none&quot;</span>))]
</span><span class="kw">fn </span>gen_hasher_seed(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="kw">let </span>stack = <span class="self">self </span><span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_ as </span>usize;
<span class="kw">let </span>previous = <span class="self">self</span>.counter.load(Ordering::Relaxed);
<span class="kw">let </span>new = previous.wrapping_add(stack);
<span class="self">self</span>.counter.store(new, Ordering::Relaxed);
new
}
}
<span class="doccomment">/// Provides a [Hasher] factory. This is typically used (e.g. by [HashMap]) to create
/// [AHasher]s in order to hash the keys of the map. See `build_hasher` below.
///
/// [build_hasher]: ahash::
/// [Hasher]: std::hash::Hasher
/// [BuildHasher]: std::hash::BuildHasher
/// [HashMap]: std::collections::HashMap
</span><span class="attribute">#[derive(Clone)]
</span><span class="kw">pub struct </span>RandomState {
<span class="kw">pub</span>(<span class="kw">crate</span>) k0: u64,
<span class="kw">pub</span>(<span class="kw">crate</span>) k1: u64,
<span class="kw">pub</span>(<span class="kw">crate</span>) k2: u64,
<span class="kw">pub</span>(<span class="kw">crate</span>) k3: u64,
}
<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>RandomState {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
f.pad(<span class="string">&quot;RandomState { .. }&quot;</span>)
}
}
<span class="kw">impl </span>RandomState {
<span class="doccomment">/// Provides an optional way to manually supply a source of randomness for Hasher keys.
///
/// The provided [RandomSource] will be used to be used as a source of randomness by [RandomState] to generate new states.
/// If this method is not invoked the standard source of randomness is used as described in the Readme.
///
/// The source of randomness can only be set once, and must be set before the first RandomState is created.
/// If the source has already been specified `Err` is returned with a `bool` indicating if the set failed because
/// method was previously invoked (true) or if the default source is already being used (false).
</span><span class="attribute">#[cfg(not(all(target_arch = <span class="string">&quot;arm&quot;</span>, target_os = <span class="string">&quot;none&quot;</span>)))]
</span><span class="kw">pub fn </span>set_random_source(source: <span class="kw">impl </span>RandomSource + Send + Sync + <span class="lifetime">&#39;static</span>) -&gt; <span class="prelude-ty">Result</span>&lt;(), bool&gt; {
RAND_SOURCE.set(Box::new(Box::new(source))).map_err(|s| s.as_ref().type_id() != TypeId::of::&lt;<span class="kw-2">&amp;</span>DefaultRandomSource&gt;())
}
<span class="attribute">#[inline]
#[cfg(not(all(target_arch = <span class="string">&quot;arm&quot;</span>, target_os = <span class="string">&quot;none&quot;</span>)))]
</span><span class="kw">fn </span>get_src() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span><span class="kw">dyn </span>RandomSource {
RAND_SOURCE.get_or_init(|| Box::new(Box::new(DefaultRandomSource::new()))).as_ref()
}
<span class="attribute">#[inline]
#[cfg(all(target_arch = <span class="string">&quot;arm&quot;</span>, target_os = <span class="string">&quot;none&quot;</span>))]
</span><span class="kw">fn </span>get_src() -&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;static </span><span class="kw">dyn </span>RandomSource {
<span class="kw">static </span>RAND_SOURCE: DefaultRandomSource = DefaultRandomSource::default();
<span class="kw-2">&amp;</span>RAND_SOURCE
}
<span class="doccomment">/// Use randomly generated keys
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>new() -&gt; RandomState {
<span class="kw">let </span>src = <span class="self">Self</span>::get_src();
<span class="kw">let </span>fixed = src.get_fixed_seeds();
<span class="self">Self</span>::from_keys(<span class="kw-2">&amp;</span>fixed[<span class="number">0</span>], <span class="kw-2">&amp;</span>fixed[<span class="number">1</span>], src.gen_hasher_seed())
}
<span class="doccomment">/// Allows for supplying seeds, but each time it is called the resulting state will be different.
/// This is done using a static counter, so it can safely be used with a fixed keys.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>generate_with(k0: u64, k1: u64, k2: u64, k3: u64) -&gt; RandomState {
<span class="kw">let </span>src = <span class="self">Self</span>::get_src();
<span class="kw">let </span>fixed = src.get_fixed_seeds();
RandomState::from_keys(<span class="kw-2">&amp;</span>fixed[<span class="number">0</span>], <span class="kw-2">&amp;</span>[k0, k1, k2, k3], src.gen_hasher_seed())
}
<span class="kw">fn </span>from_keys(a: <span class="kw-2">&amp;</span>[u64; <span class="number">4</span>], b: <span class="kw-2">&amp;</span>[u64; <span class="number">4</span>], c: usize) -&gt; RandomState {
<span class="kw">let </span><span class="kw-2">&amp;</span>[k0, k1, k2, k3] = a;
<span class="kw">let </span><span class="kw-2">mut </span>hasher = AHasher::from_random_state(<span class="kw-2">&amp;</span>RandomState { k0, k1, k2, k3 });
hasher.write_usize(c);
<span class="kw">let </span>mix = |k: u64| {
<span class="kw">let </span><span class="kw-2">mut </span>h = hasher.clone();
h.write_u64(k);
h.finish()
};
RandomState {
k0: mix(b[<span class="number">0</span>]),
k1: mix(b[<span class="number">1</span>]),
k2: mix(b[<span class="number">2</span>]),
k3: mix(b[<span class="number">3</span>]),
}
}
<span class="doccomment">/// Internal. Used by Default.
</span><span class="attribute">#[inline]
</span><span class="kw">pub</span>(<span class="kw">crate</span>) <span class="kw">fn </span>with_fixed_keys() -&gt; RandomState {
<span class="kw">let </span>[k0, k1, k2, k3] = <span class="self">Self</span>::get_src().get_fixed_seeds()[<span class="number">0</span>];
RandomState { k0, k1, k2, k3 }
}
<span class="doccomment">/// Allows for explicitly setting a seed to used.
///
/// Note: This method does not require the provided seed to be strong.
</span><span class="attribute">#[inline]
</span><span class="kw">pub fn </span>with_seed(key: usize) -&gt; RandomState {
<span class="kw">let </span>fixed = <span class="self">Self</span>::get_src().get_fixed_seeds();
RandomState::from_keys(<span class="kw-2">&amp;</span>fixed[<span class="number">0</span>], <span class="kw-2">&amp;</span>fixed[<span class="number">1</span>], key)
}
<span class="doccomment">/// Allows for explicitly setting the seeds to used.
///
/// Note: This method is robust against 0s being passed for one or more of the parameters
/// or the same value being passed for more than one parameter.
</span><span class="attribute">#[inline]
</span><span class="kw">pub const fn </span>with_seeds(k0: u64, k1: u64, k2: u64, k3: u64) -&gt; RandomState {
RandomState { k0: k0 ^ PI2[<span class="number">0</span>], k1: k1 ^ PI2[<span class="number">1</span>], k2: k2 ^ PI2[<span class="number">2</span>], k3: k3 ^ PI2[<span class="number">3</span>] }
}
}
<span class="kw">impl </span>Default <span class="kw">for </span>RandomState {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<span class="self">Self</span>::new()
}
}
<span class="kw">impl </span>BuildHasher <span class="kw">for </span>RandomState {
<span class="kw">type </span>Hasher = AHasher;
<span class="doccomment">/// Constructs a new [AHasher] with keys based on this [RandomState] object.
/// This means that two different [RandomState]s will will generate
/// [AHasher]s that will return different hashcodes, but [Hasher]s created from the same [BuildHasher]
/// will generate the same hashes for the same input data.
///
/// # Examples
///
/// ```
/// use ahash::{AHasher, RandomState};
/// use std::hash::{Hasher, BuildHasher};
///
/// let build_hasher = RandomState::new();
/// let mut hasher_1 = build_hasher.build_hasher();
/// let mut hasher_2 = build_hasher.build_hasher();
///
/// hasher_1.write_u32(1234);
/// hasher_2.write_u32(1234);
///
/// assert_eq!(hasher_1.finish(), hasher_2.finish());
///
/// let other_build_hasher = RandomState::new();
/// let mut different_hasher = other_build_hasher.build_hasher();
/// different_hasher.write_u32(1234);
/// assert_ne!(different_hasher.finish(), hasher_1.finish());
/// ```
/// [Hasher]: std::hash::Hasher
/// [BuildHasher]: std::hash::BuildHasher
/// [HashMap]: std::collections::HashMap
</span><span class="attribute">#[inline]
</span><span class="kw">fn </span>build_hasher(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; AHasher {
AHasher::from_random_state(<span class="self">self</span>)
}
}
<span class="attribute">#[cfg(feature = <span class="string">&quot;specialize&quot;</span>)]
</span><span class="kw">impl </span>BuildHasherExt <span class="kw">for </span>RandomState {
<span class="attribute">#[inline]
</span><span class="kw">fn </span>hash_as_u64&lt;T: Hash + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, value: <span class="kw-2">&amp;</span>T) -&gt; u64 {
<span class="kw">let </span><span class="kw-2">mut </span>hasher = AHasherU64 {
buffer: <span class="self">self</span>.k0,
pad: <span class="self">self</span>.k1,
};
value.hash(<span class="kw-2">&amp;mut </span>hasher);
hasher.finish()
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>hash_as_fixed_length&lt;T: Hash + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, value: <span class="kw-2">&amp;</span>T) -&gt; u64 {
<span class="kw">let </span><span class="kw-2">mut </span>hasher = AHasherFixed(<span class="self">self</span>.build_hasher());
value.hash(<span class="kw-2">&amp;mut </span>hasher);
hasher.finish()
}
<span class="attribute">#[inline]
</span><span class="kw">fn </span>hash_as_str&lt;T: Hash + <span class="question-mark">?</span>Sized&gt;(<span class="kw-2">&amp;</span><span class="self">self</span>, value: <span class="kw-2">&amp;</span>T) -&gt; u64 {
<span class="kw">let </span><span class="kw-2">mut </span>hasher = AHasherStr(<span class="self">self</span>.build_hasher());
value.hash(<span class="kw-2">&amp;mut </span>hasher);
hasher.finish()
}
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>test {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_unique() {
<span class="kw">let </span>a = RandomState::new();
<span class="kw">let </span>b = RandomState::new();
<span class="macro">assert_ne!</span>(a.build_hasher().finish(), b.build_hasher().finish());
}
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;runtime-rng&quot;</span>, not(all(feature = <span class="string">&quot;compile-time-rng&quot;</span>, test))))]
#[test]
</span><span class="kw">fn </span>test_not_pi() {
<span class="macro">assert_ne!</span>(PI, RandomState::get_src().get_fixed_seeds()[<span class="number">0</span>]);
}
<span class="attribute">#[cfg(all(feature = <span class="string">&quot;compile-time-rng&quot;</span>, any(not(feature = <span class="string">&quot;runtime-rng&quot;</span>), test)))]
#[test]
</span><span class="kw">fn </span>test_not_pi_const() {
<span class="macro">assert_ne!</span>(PI, RandomState::get_src().get_fixed_seeds()[<span class="number">0</span>]);
}
<span class="attribute">#[cfg(all(not(feature = <span class="string">&quot;runtime-rng&quot;</span>), not(feature = <span class="string">&quot;compile-time-rng&quot;</span>)))]
#[test]
</span><span class="kw">fn </span>test_pi() {
<span class="macro">assert_eq!</span>(PI, RandomState::get_src().get_fixed_seeds()[<span class="number">0</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_with_seeds_const() {
<span class="kw">const </span>_CONST_RANDOM_STATE: RandomState = RandomState::with_seeds(<span class="number">17</span>, <span class="number">19</span>, <span class="number">21</span>, <span class="number">23</span>);
}
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="ahash" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>