195 lines
15 KiB
HTML
195 lines
15 KiB
HTML
<!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 to the Rust file `C:\Users\evilc\.cargo\registry\src\github.com-1ecc6299db9ec823\getrandom-0.1.7\src\util.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>util.rs.html -- source</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"><style type="text/css">#crate-search{background-image:url("../../down-arrow.svg");}</style></head><body class="rustdoc source"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><a href='../../getrandom/index.html'><div class='logo-container'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo'></div></a></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><pre class="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>
|
||
</pre><div class="example-wrap"><pre class="rust ">
|
||
<span class="comment">// Copyright 2019 Developers of the Rand project.</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or</span>
|
||
<span class="comment">// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license</span>
|
||
<span class="comment">// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your</span>
|
||
<span class="comment">// option. This file may not be copied, modified, or distributed</span>
|
||
<span class="comment">// except according to those terms.</span>
|
||
|
||
<span class="kw">use</span> <span class="ident">core</span>::<span class="ident">sync</span>::<span class="ident">atomic</span>::{<span class="ident">AtomicUsize</span>, <span class="ident">Ordering</span>::<span class="ident">Relaxed</span>};
|
||
|
||
<span class="comment">// This structure represents a laziliy initialized static usize value. Useful</span>
|
||
<span class="comment">// when it is perferable to just rerun initialization instead of locking.</span>
|
||
<span class="comment">// Both unsync_init and sync_init will invoke an init() function until it</span>
|
||
<span class="comment">// succeeds, then return the cached value for future calls.</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// Both methods support init() "failing". If the init() method returns UNINIT,</span>
|
||
<span class="comment">// that value will be returned as normal, but will not be cached.</span>
|
||
<span class="comment">//</span>
|
||
<span class="comment">// Users should only depend on the _value_ returned by init() functions.</span>
|
||
<span class="comment">// Specifically, for the following init() function:</span>
|
||
<span class="comment">// fn init() -> usize {</span>
|
||
<span class="comment">// a();</span>
|
||
<span class="comment">// let v = b();</span>
|
||
<span class="comment">// c();</span>
|
||
<span class="comment">// v</span>
|
||
<span class="comment">// }</span>
|
||
<span class="comment">// the effects of c() or writes to shared memory will not necessarily be</span>
|
||
<span class="comment">// observed and additional syncronization methods with be needed.</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">LazyUsize</span>(<span class="ident">AtomicUsize</span>);
|
||
|
||
<span class="kw">impl</span> <span class="ident">LazyUsize</span> {
|
||
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="self">Self</span> {
|
||
<span class="self">Self</span>(<span class="ident">AtomicUsize</span>::<span class="ident">new</span>(<span class="self">Self</span>::<span class="ident">UNINIT</span>))
|
||
}
|
||
|
||
<span class="comment">// The initialization is not completed.</span>
|
||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">UNINIT</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="ident">usize</span>::<span class="ident">max_value</span>();
|
||
<span class="comment">// The initialization is currently running.</span>
|
||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">ACTIVE</span>: <span class="ident">usize</span> <span class="op">=</span> <span class="ident">usize</span>::<span class="ident">max_value</span>() <span class="op">-</span> <span class="number">1</span>;
|
||
|
||
<span class="comment">// Runs the init() function at least once, returning the value of some run</span>
|
||
<span class="comment">// of init(). Multiple callers can run their init() functions in parallel.</span>
|
||
<span class="comment">// init() should always return the same value, if it succeeds.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unsync_init</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">init</span>: <span class="kw">impl</span> <span class="ident">FnOnce</span>() <span class="op">-></span> <span class="ident">usize</span>) <span class="op">-></span> <span class="ident">usize</span> {
|
||
<span class="comment">// Relaxed ordering is fine, as we only have a single atomic variable.</span>
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">val</span> <span class="op">=</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">load</span>(<span class="ident">Relaxed</span>);
|
||
<span class="kw">if</span> <span class="ident">val</span> <span class="op">==</span> <span class="self">Self</span>::<span class="ident">UNINIT</span> {
|
||
<span class="ident">val</span> <span class="op">=</span> <span class="ident">init</span>();
|
||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">store</span>(<span class="ident">val</span>, <span class="ident">Relaxed</span>);
|
||
}
|
||
<span class="ident">val</span>
|
||
}
|
||
|
||
<span class="comment">// Synchronously runs the init() function. Only one caller will have their</span>
|
||
<span class="comment">// init() function running at a time, and exactly one successful call will</span>
|
||
<span class="comment">// be run. init() returning UNINIT or ACTIVE will be considered a failure,</span>
|
||
<span class="comment">// and future calls to sync_init will rerun their init() function.</span>
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sync_init</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">init</span>: <span class="kw">impl</span> <span class="ident">FnOnce</span>() <span class="op">-></span> <span class="ident">usize</span>, <span class="kw-2">mut</span> <span class="ident">wait</span>: <span class="kw">impl</span> <span class="ident">FnMut</span>()) <span class="op">-></span> <span class="ident">usize</span> {
|
||
<span class="comment">// Common and fast path with no contention. Don't wast time on CAS.</span>
|
||
<span class="kw">match</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">load</span>(<span class="ident">Relaxed</span>) {
|
||
<span class="self">Self</span>::<span class="ident">UNINIT</span> <span class="op">|</span> <span class="self">Self</span>::<span class="ident">ACTIVE</span> <span class="op">=></span> {}
|
||
<span class="ident">val</span> <span class="op">=></span> <span class="kw">return</span> <span class="ident">val</span>,
|
||
}
|
||
<span class="comment">// Relaxed ordering is fine, as we only have a single atomic variable.</span>
|
||
<span class="kw">loop</span> {
|
||
<span class="kw">match</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">compare_and_swap</span>(<span class="self">Self</span>::<span class="ident">UNINIT</span>, <span class="self">Self</span>::<span class="ident">ACTIVE</span>, <span class="ident">Relaxed</span>) {
|
||
<span class="self">Self</span>::<span class="ident">UNINIT</span> <span class="op">=></span> {
|
||
<span class="kw">let</span> <span class="ident">val</span> <span class="op">=</span> <span class="ident">init</span>();
|
||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">store</span>(
|
||
<span class="kw">match</span> <span class="ident">val</span> {
|
||
<span class="self">Self</span>::<span class="ident">UNINIT</span> <span class="op">|</span> <span class="self">Self</span>::<span class="ident">ACTIVE</span> <span class="op">=></span> <span class="self">Self</span>::<span class="ident">UNINIT</span>,
|
||
<span class="ident">val</span> <span class="op">=></span> <span class="ident">val</span>,
|
||
},
|
||
<span class="ident">Relaxed</span>,
|
||
);
|
||
<span class="kw">return</span> <span class="ident">val</span>;
|
||
}
|
||
<span class="self">Self</span>::<span class="ident">ACTIVE</span> <span class="op">=></span> <span class="ident">wait</span>(),
|
||
<span class="ident">val</span> <span class="op">=></span> <span class="kw">return</span> <span class="ident">val</span>,
|
||
}
|
||
}
|
||
}
|
||
}
|
||
|
||
<span class="comment">// Identical to LazyUsize except with bool instead of usize.</span>
|
||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">LazyBool</span>(<span class="ident">LazyUsize</span>);
|
||
|
||
<span class="kw">impl</span> <span class="ident">LazyBool</span> {
|
||
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() <span class="op">-></span> <span class="self">Self</span> {
|
||
<span class="self">Self</span>(<span class="ident">LazyUsize</span>::<span class="ident">new</span>())
|
||
}
|
||
|
||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">unsync_init</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">init</span>: <span class="kw">impl</span> <span class="ident">FnOnce</span>() <span class="op">-></span> <span class="ident">bool</span>) <span class="op">-></span> <span class="ident">bool</span> {
|
||
<span class="self">self</span>.<span class="number">0</span>.<span class="ident">unsync_init</span>(<span class="op">||</span> <span class="ident">init</span>() <span class="kw">as</span> <span class="ident">usize</span>) <span class="op">!=</span> <span class="number">0</span>
|
||
}
|
||
}
|
||
</pre></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><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</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><p>Search multiple things at once by splitting your query with comma (e.g., <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "getrandom";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script src="../../source-script.js"></script><script src="../../source-files.js"></script><script defer src="../../search-index.js"></script></body></html> |