Now a REAL lib
This commit is contained in:
Justine
386
doc/src/getrandom/error.rs.html
Normal file
386
doc/src/getrandom/error.rs.html
Normal file
@ -0,0 +1,386 @@
|
||||
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.8/src/error.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error.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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="icon" href="https://www.rust-lang.org/favicon.ico"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" 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><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" 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><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../getrandom/index.html">
|
||||
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><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>
|
||||
<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>
|
||||
</pre><pre class="rust"><code><span class="comment">// Copyright 2018 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">fmt</span>, <span class="ident">num::NonZeroU32</span>};
|
||||
|
||||
<span class="doccomment">/// A small and `no_std` compatible error type</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// The [`Error::raw_os_error()`] will indicate if the error is from the OS, and</span>
|
||||
<span class="doccomment">/// if so, which error code the OS gave the application. If such an error is</span>
|
||||
<span class="doccomment">/// encountered, please consult with your system documentation.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Internally this type is a NonZeroU32, with certain values reserved for</span>
|
||||
<span class="doccomment">/// certain purposes, see [`Error::INTERNAL_START`] and [`Error::CUSTOM_START`].</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// *If this crate's `"std"` Cargo feature is enabled*, then:</span>
|
||||
<span class="doccomment">/// - [`getrandom::Error`][Error] implements</span>
|
||||
<span class="doccomment">/// [`std::error::Error`](https://doc.rust-lang.org/std/error/trait.Error.html)</span>
|
||||
<span class="doccomment">/// - [`std::io::Error`](https://doc.rust-lang.org/std/io/struct.Error.html) implements</span>
|
||||
<span class="doccomment">/// [`From<getrandom::Error>`](https://doc.rust-lang.org/std/convert/trait.From.html).</span>
|
||||
<span class="attribute">#[<span class="ident">derive</span>(<span class="ident">Copy</span>, <span class="ident">Clone</span>, <span class="ident">Eq</span>, <span class="ident">PartialEq</span>)]</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Error</span>(<span class="ident">NonZeroU32</span>);
|
||||
|
||||
<span class="kw">const</span> <span class="kw">fn</span> <span class="ident">internal_error</span>(<span class="ident">n</span>: <span class="ident">u16</span>) -> <span class="ident">Error</span> {
|
||||
<span class="comment">// SAFETY: code > 0 as INTERNAL_START > 0 and adding n won't overflow a u32.</span>
|
||||
<span class="kw">let</span> <span class="ident">code</span> <span class="op">=</span> <span class="ident">Error::INTERNAL_START</span> <span class="op">+</span> (<span class="ident">n</span> <span class="kw">as</span> <span class="ident">u32</span>);
|
||||
<span class="ident">Error</span>(<span class="kw">unsafe</span> { <span class="ident">NonZeroU32::new_unchecked</span>(<span class="ident">code</span>) })
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Error</span> {
|
||||
<span class="doccomment">/// This target/platform is not supported by `getrandom`.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">UNSUPPORTED</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">0</span>);
|
||||
<span class="doccomment">/// The platform-specific `errno` returned a non-positive value.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">ERRNO_NOT_POSITIVE</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">1</span>);
|
||||
<span class="doccomment">/// Call to iOS [`SecRandomCopyBytes`](https://developer.apple.com/documentation/security/1399291-secrandomcopybytes) failed.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">IOS_SEC_RANDOM</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">3</span>);
|
||||
<span class="doccomment">/// Call to Windows [`RtlGenRandom`](https://docs.microsoft.com/en-us/windows/win32/api/ntsecapi/nf-ntsecapi-rtlgenrandom) failed.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">WINDOWS_RTL_GEN_RANDOM</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">4</span>);
|
||||
<span class="doccomment">/// RDRAND instruction failed due to a hardware issue.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">FAILED_RDRAND</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">5</span>);
|
||||
<span class="doccomment">/// RDRAND instruction unsupported on this target.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">NO_RDRAND</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">6</span>);
|
||||
<span class="doccomment">/// The environment does not support the Web Crypto API.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">WEB_CRYPTO</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">7</span>);
|
||||
<span class="doccomment">/// Calling Web Crypto API `crypto.getRandomValues` failed.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">WEB_GET_RANDOM_VALUES</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">8</span>);
|
||||
<span class="doccomment">/// On VxWorks, call to `randSecure` failed (random number generator is not yet initialized).</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">VXWORKS_RAND_SECURE</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">11</span>);
|
||||
<span class="doccomment">/// Node.js does not have the `crypto` CommonJS module.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">NODE_CRYPTO</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">12</span>);
|
||||
<span class="doccomment">/// Calling Node.js function `crypto.randomFillSync` failed.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">NODE_RANDOM_FILL_SYNC</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">13</span>);
|
||||
<span class="doccomment">/// Called from an ES module on Node.js. This is unsupported, see:</span>
|
||||
<span class="doccomment">/// <https://docs.rs/getrandom#nodejs-es-module-support>.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">NODE_ES_MODULE</span>: <span class="ident">Error</span> <span class="op">=</span> <span class="ident">internal_error</span>(<span class="number">14</span>);
|
||||
|
||||
<span class="doccomment">/// Codes below this point represent OS Errors (i.e. positive i32 values).</span>
|
||||
<span class="doccomment">/// Codes at or above this point, but below [`Error::CUSTOM_START`] are</span>
|
||||
<span class="doccomment">/// reserved for use by the `rand` and `getrandom` crates.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">INTERNAL_START</span>: <span class="ident">u32</span> <span class="op">=</span> <span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">31</span>;
|
||||
|
||||
<span class="doccomment">/// Codes at or above this point can be used by users to define their own</span>
|
||||
<span class="doccomment">/// custom errors.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="ident">CUSTOM_START</span>: <span class="ident">u32</span> <span class="op">=</span> (<span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">31</span>) <span class="op">+</span> (<span class="number">1</span> <span class="op"><</span><span class="op"><</span> <span class="number">30</span>);
|
||||
|
||||
<span class="doccomment">/// Extract the raw OS error code (if this error came from the OS)</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// This method is identical to [`std::io::Error::raw_os_error()`][1], except</span>
|
||||
<span class="doccomment">/// that it works in `no_std` contexts. If this method returns `None`, the</span>
|
||||
<span class="doccomment">/// error value can still be formatted via the `Display` implementation.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// [1]: https://doc.rust-lang.org/std/io/struct.Error.html#method.raw_os_error</span>
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">raw_os_error</span>(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">i32</span><span class="op">></span> {
|
||||
<span class="kw">if</span> <span class="self">self</span>.<span class="number">0</span>.<span class="ident">get</span>() <span class="op"><</span> <span class="ident"><span class="self">Self</span>::INTERNAL_START</span> {
|
||||
<span class="kw">match</span> () {
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"solid_asp3"</span>)]</span>
|
||||
<span class="comment">// On SOLID, negate the error code again to obtain the original</span>
|
||||
<span class="comment">// error code.</span>
|
||||
() => <span class="prelude-val">Some</span>(<span class="op">-</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">get</span>() <span class="kw">as</span> <span class="ident">i32</span>)),
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">not</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"solid_asp3"</span>))]</span>
|
||||
() => <span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">get</span>() <span class="kw">as</span> <span class="ident">i32</span>),
|
||||
}
|
||||
} <span class="kw">else</span> {
|
||||
<span class="prelude-val">None</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Extract the bare error code.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// This code can either come from the underlying OS, or be a custom error.</span>
|
||||
<span class="doccomment">/// Use [`Error::raw_os_error()`] to disambiguate.</span>
|
||||
<span class="attribute">#[<span class="ident">inline</span>]</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">fn</span> <span class="ident">code</span>(<span class="self">self</span>) -> <span class="ident">NonZeroU32</span> {
|
||||
<span class="self">self</span>.<span class="number">0</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="macro">cfg_if!</span> {
|
||||
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">unix</span>)]</span> {
|
||||
<span class="kw">fn</span> <span class="ident">os_err</span>(<span class="ident">errno</span>: <span class="ident">i32</span>, <span class="ident">buf</span>: <span class="kw-2">&mut</span> [<span class="ident">u8</span>]) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">buf_ptr</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">as_mut_ptr</span>() <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="ident">libc::c_char</span>;
|
||||
<span class="kw">if</span> <span class="kw">unsafe</span> { <span class="ident">libc::strerror_r</span>(<span class="ident">errno</span>, <span class="ident">buf_ptr</span>, <span class="ident">buf</span>.<span class="ident">len</span>()) } <span class="op">!</span><span class="op">=</span> <span class="number">0</span> {
|
||||
<span class="kw">return</span> <span class="prelude-val">None</span>;
|
||||
}
|
||||
|
||||
<span class="comment">// Take up to trailing null byte</span>
|
||||
<span class="kw">let</span> <span class="ident">n</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">len</span>();
|
||||
<span class="kw">let</span> <span class="ident">idx</span> <span class="op">=</span> <span class="ident">buf</span>.<span class="ident">iter</span>().<span class="ident">position</span>(<span class="op">|</span><span class="kw-2">&</span><span class="ident">b</span><span class="op">|</span> <span class="ident">b</span> <span class="op">==</span> <span class="number">0</span>).<span class="ident">unwrap_or</span>(<span class="ident">n</span>);
|
||||
<span class="ident">core::str::from_utf8</span>(<span class="kw-2">&</span><span class="ident">buf</span>[..<span class="ident">idx</span>]).<span class="ident">ok</span>()
|
||||
}
|
||||
} <span class="kw">else</span> {
|
||||
<span class="kw">fn</span> <span class="ident">os_err</span>(<span class="ident">_errno</span>: <span class="ident">i32</span>, <span class="ident">_buf</span>: <span class="kw-2">&mut</span> [<span class="ident">u8</span>]) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="ident">str</span><span class="op">></span> {
|
||||
<span class="prelude-val">None</span>
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Debug</span> <span class="kw">for</span> <span class="ident">Error</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">dbg</span> <span class="op">=</span> <span class="ident">f</span>.<span class="ident">debug_struct</span>(<span class="string">"Error"</span>);
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">errno</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">raw_os_error</span>() {
|
||||
<span class="ident">dbg</span>.<span class="ident">field</span>(<span class="string">"os_error"</span>, <span class="kw-2">&</span><span class="ident">errno</span>);
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0u8</span>; <span class="number">128</span>];
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">err</span>) <span class="op">=</span> <span class="ident">os_err</span>(<span class="ident">errno</span>, <span class="kw-2">&mut</span> <span class="ident">buf</span>) {
|
||||
<span class="ident">dbg</span>.<span class="ident">field</span>(<span class="string">"description"</span>, <span class="kw-2">&</span><span class="ident">err</span>);
|
||||
}
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">desc</span>) <span class="op">=</span> <span class="ident">internal_desc</span>(<span class="kw-2">*</span><span class="self">self</span>) {
|
||||
<span class="ident">dbg</span>.<span class="ident">field</span>(<span class="string">"internal_code"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>.<span class="ident">get</span>());
|
||||
<span class="ident">dbg</span>.<span class="ident">field</span>(<span class="string">"description"</span>, <span class="kw-2">&</span><span class="ident">desc</span>);
|
||||
} <span class="kw">else</span> {
|
||||
<span class="ident">dbg</span>.<span class="ident">field</span>(<span class="string">"unknown_code"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>.<span class="ident">get</span>());
|
||||
}
|
||||
<span class="ident">dbg</span>.<span class="ident">finish</span>()
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">fmt::Display</span> <span class="kw">for</span> <span class="ident">Error</span> {
|
||||
<span class="kw">fn</span> <span class="ident">fmt</span>(<span class="kw-2">&</span><span class="self">self</span>, <span class="ident">f</span>: <span class="kw-2">&mut</span> <span class="ident">fmt::Formatter</span><span class="op"><</span><span class="lifetime">'_</span><span class="op">></span>) -> <span class="ident">fmt::Result</span> {
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">errno</span>) <span class="op">=</span> <span class="self">self</span>.<span class="ident">raw_os_error</span>() {
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">buf</span> <span class="op">=</span> [<span class="number">0u8</span>; <span class="number">128</span>];
|
||||
<span class="kw">match</span> <span class="ident">os_err</span>(<span class="ident">errno</span>, <span class="kw-2">&mut</span> <span class="ident">buf</span>) {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">err</span>) => <span class="ident">err</span>.<span class="ident">fmt</span>(<span class="ident">f</span>),
|
||||
<span class="prelude-val">None</span> => <span class="macro">write!</span>(<span class="ident">f</span>, <span class="string">"OS Error: {}"</span>, <span class="ident">errno</span>),
|
||||
}
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">desc</span>) <span class="op">=</span> <span class="ident">internal_desc</span>(<span class="kw-2">*</span><span class="self">self</span>) {
|
||||
<span class="ident">f</span>.<span class="ident">write_str</span>(<span class="ident">desc</span>)
|
||||
} <span class="kw">else</span> {
|
||||
<span class="macro">write!</span>(<span class="ident">f</span>, <span class="string">"Unknown Error: {}"</span>, <span class="self">self</span>.<span class="number">0</span>.<span class="ident">get</span>())
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">From</span><span class="op"><</span><span class="ident">NonZeroU32</span><span class="op">></span> <span class="kw">for</span> <span class="ident">Error</span> {
|
||||
<span class="kw">fn</span> <span class="ident">from</span>(<span class="ident">code</span>: <span class="ident">NonZeroU32</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span>(<span class="ident">code</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">internal_desc</span>(<span class="ident">error</span>: <span class="ident">Error</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="ident">error</span> {
|
||||
<span class="ident">Error::UNSUPPORTED</span> => <span class="prelude-val">Some</span>(<span class="string">"getrandom: this target is not supported"</span>),
|
||||
<span class="ident">Error::ERRNO_NOT_POSITIVE</span> => <span class="prelude-val">Some</span>(<span class="string">"errno: did not return a positive value"</span>),
|
||||
<span class="ident">Error::IOS_SEC_RANDOM</span> => <span class="prelude-val">Some</span>(<span class="string">"SecRandomCopyBytes: iOS Security framework failure"</span>),
|
||||
<span class="ident">Error::WINDOWS_RTL_GEN_RANDOM</span> => <span class="prelude-val">Some</span>(<span class="string">"RtlGenRandom: Windows system function failure"</span>),
|
||||
<span class="ident">Error::FAILED_RDRAND</span> => <span class="prelude-val">Some</span>(<span class="string">"RDRAND: failed multiple times: CPU issue likely"</span>),
|
||||
<span class="ident">Error::NO_RDRAND</span> => <span class="prelude-val">Some</span>(<span class="string">"RDRAND: instruction not supported"</span>),
|
||||
<span class="ident">Error::WEB_CRYPTO</span> => <span class="prelude-val">Some</span>(<span class="string">"Web Crypto API is unavailable"</span>),
|
||||
<span class="ident">Error::WEB_GET_RANDOM_VALUES</span> => <span class="prelude-val">Some</span>(<span class="string">"Calling Web API crypto.getRandomValues failed"</span>),
|
||||
<span class="ident">Error::VXWORKS_RAND_SECURE</span> => <span class="prelude-val">Some</span>(<span class="string">"randSecure: VxWorks RNG module is not initialized"</span>),
|
||||
<span class="ident">Error::NODE_CRYPTO</span> => <span class="prelude-val">Some</span>(<span class="string">"Node.js crypto CommonJS module is unavailable"</span>),
|
||||
<span class="ident">Error::NODE_RANDOM_FILL_SYNC</span> => <span class="prelude-val">Some</span>(<span class="string">"Calling Node.js API crypto.randomFillSync failed"</span>),
|
||||
<span class="ident">Error::NODE_ES_MODULE</span> => <span class="prelude-val">Some</span>(<span class="string">"Node.js ES modules are not directly supported, see https://docs.rs/getrandom#nodejs-es-module-support"</span>),
|
||||
<span class="kw">_</span> => <span class="prelude-val">None</span>,
|
||||
}
|
||||
}
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">test</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">tests</span> {
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">super</span>::Error</span>;
|
||||
<span class="kw">use</span> <span class="ident">core::mem::size_of</span>;
|
||||
|
||||
<span class="attribute">#[<span class="ident">test</span>]</span>
|
||||
<span class="kw">fn</span> <span class="ident">test_size</span>() {
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">size_of</span>::<span class="op"><</span><span class="ident">Error</span><span class="op">></span>(), <span class="number">4</span>);
|
||||
<span class="macro">assert_eq!</span>(<span class="ident">size_of</span>::<span class="op"><</span><span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span><span class="op">></span>(), <span class="number">4</span>);
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="getrandom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
586
doc/src/getrandom/lib.rs.html
Normal file
586
doc/src/getrandom/lib.rs.html
Normal file
@ -0,0 +1,586 @@
|
||||
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.8/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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="icon" href="https://www.rust-lang.org/favicon.ico"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" 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><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" 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><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../getrandom/index.html">
|
||||
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><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>
|
||||
<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>
|
||||
</pre><pre class="rust"><code><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="doccomment">//! Interface to the operating system's random number generator.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! # Supported targets</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! | Target | Target Triple | Implementation</span>
|
||||
<span class="doccomment">//! | ----------------- | ------------------ | --------------</span>
|
||||
<span class="doccomment">//! | Linux, Android | `*‑linux‑*` | [`getrandom`][1] system call if available, otherwise [`/dev/urandom`][2] after successfully polling `/dev/random`</span>
|
||||
<span class="doccomment">//! | Windows | `*‑windows‑*` | [`BCryptGenRandom`]</span>
|
||||
<span class="doccomment">//! | macOS | `*‑apple‑darwin` | [`getentropy`][3] if available, otherwise [`/dev/random`][4] (identical to `/dev/urandom`)</span>
|
||||
<span class="doccomment">//! | iOS | `*‑apple‑ios` | [`SecRandomCopyBytes`]</span>
|
||||
<span class="doccomment">//! | FreeBSD | `*‑freebsd` | [`getrandom`][5] if available, otherwise [`kern.arandom`][6]</span>
|
||||
<span class="doccomment">//! | OpenBSD | `*‑openbsd` | [`getentropy`][7]</span>
|
||||
<span class="doccomment">//! | NetBSD | `*‑netbsd` | [`kern.arandom`][8]</span>
|
||||
<span class="doccomment">//! | Dragonfly BSD | `*‑dragonfly` | [`getrandom`][9] if available, otherwise [`/dev/random`][10]</span>
|
||||
<span class="doccomment">//! | Solaris, illumos | `*‑solaris`, `*‑illumos` | [`getrandom`][11] if available, otherwise [`/dev/random`][12]</span>
|
||||
<span class="doccomment">//! | Fuchsia OS | `*‑fuchsia` | [`cprng_draw`]</span>
|
||||
<span class="doccomment">//! | Redox | `*‑redox` | `/dev/urandom`</span>
|
||||
<span class="doccomment">//! | Haiku | `*‑haiku` | `/dev/random` (identical to `/dev/urandom`)</span>
|
||||
<span class="doccomment">//! | Hermit | `x86_64-*-hermit` | [`RDRAND`]</span>
|
||||
<span class="doccomment">//! | SGX | `x86_64‑*‑sgx` | [`RDRAND`]</span>
|
||||
<span class="doccomment">//! | VxWorks | `*‑wrs‑vxworks‑*` | `randABytes` after checking entropy pool initialization with `randSecure`</span>
|
||||
<span class="doccomment">//! | ESP-IDF | `*‑espidf` | [`esp_fill_random`]</span>
|
||||
<span class="doccomment">//! | Emscripten | `*‑emscripten` | `/dev/random` (identical to `/dev/urandom`)</span>
|
||||
<span class="doccomment">//! | WASI | `wasm32‑wasi` | [`random_get`]</span>
|
||||
<span class="doccomment">//! | Web Browser and Node.js | `wasm32‑*‑unknown` | [`Crypto.getRandomValues`] if available, then [`crypto.randomFillSync`] if on Node.js, see [WebAssembly support]</span>
|
||||
<span class="doccomment">//! | SOLID | `*-kmc-solid_*` | `SOLID_RNG_SampleRandomBytes`</span>
|
||||
<span class="doccomment">//! | Nintendo 3DS | `armv6k-nintendo-3ds` | [`getrandom`][1]</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! There is no blanket implementation on `unix` targets that reads from</span>
|
||||
<span class="doccomment">//! `/dev/urandom`. This ensures all supported targets are using the recommended</span>
|
||||
<span class="doccomment">//! interface and respect maximum buffer sizes.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Pull Requests that add support for new targets to `getrandom` are always welcome.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ## Unsupported targets</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! By default, `getrandom` will not compile on unsupported targets, but certain</span>
|
||||
<span class="doccomment">//! features allow a user to select a "fallback" implementation if no supported</span>
|
||||
<span class="doccomment">//! implementation exists.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! All of the below mechanisms only affect unsupported</span>
|
||||
<span class="doccomment">//! targets. Supported targets will _always_ use their supported implementations.</span>
|
||||
<span class="doccomment">//! This prevents a crate from overriding a secure source of randomness</span>
|
||||
<span class="doccomment">//! (either accidentally or intentionally).</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ### RDRAND on x86</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! *If the `rdrand` Cargo feature is enabled*, `getrandom` will fallback to using</span>
|
||||
<span class="doccomment">//! the [`RDRAND`] instruction to get randomness on `no_std` `x86`/`x86_64`</span>
|
||||
<span class="doccomment">//! targets. This feature has no effect on other CPU architectures.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ### WebAssembly support</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! This crate fully supports the</span>
|
||||
<span class="doccomment">//! [`wasm32-wasi`](https://github.com/CraneStation/wasi) and</span>
|
||||
<span class="doccomment">//! [`wasm32-unknown-emscripten`](https://www.hellorust.com/setup/emscripten/)</span>
|
||||
<span class="doccomment">//! targets. However, the `wasm32-unknown-unknown` target (i.e. the target used</span>
|
||||
<span class="doccomment">//! by `wasm-pack`) is not automatically</span>
|
||||
<span class="doccomment">//! supported since, from the target name alone, we cannot deduce which</span>
|
||||
<span class="doccomment">//! JavaScript interface is in use (or if JavaScript is available at all).</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Instead, *if the `js` Cargo feature is enabled*, this crate will assume</span>
|
||||
<span class="doccomment">//! that you are building for an environment containing JavaScript, and will</span>
|
||||
<span class="doccomment">//! call the appropriate methods. Both web browser (main window and Web Workers)</span>
|
||||
<span class="doccomment">//! and Node.js environments are supported, invoking the methods</span>
|
||||
<span class="doccomment">//! [described above](#supported-targets) using the [`wasm-bindgen`] toolchain.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! To enable the `js` Cargo feature, add the following to the `dependencies`</span>
|
||||
<span class="doccomment">//! section in your `Cargo.toml` file:</span>
|
||||
<span class="doccomment">//! ```toml</span>
|
||||
<span class="doccomment">//! [dependencies]</span>
|
||||
<span class="doccomment">//! getrandom = { version = "0.2", features = ["js"] }</span>
|
||||
<span class="doccomment">//! ```</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! This can be done even if `getrandom` is not a direct dependency. Cargo</span>
|
||||
<span class="doccomment">//! allows crates to enable features for indirect dependencies.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! This feature should only be enabled for binary, test, or benchmark crates.</span>
|
||||
<span class="doccomment">//! Library crates should generally not enable this feature, leaving such a</span>
|
||||
<span class="doccomment">//! decision to *users* of their library. Also, libraries should not introduce</span>
|
||||
<span class="doccomment">//! their own `js` features *just* to enable `getrandom`'s `js` feature.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! This feature has no effect on targets other than `wasm32-unknown-unknown`.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! #### Node.js ES module support</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Node.js supports both [CommonJS modules] and [ES modules]. Due to</span>
|
||||
<span class="doccomment">//! limitations in wasm-bindgen's [`module`] support, we cannot directly</span>
|
||||
<span class="doccomment">//! support ES Modules running on Node.js. However, on Node v15 and later, the</span>
|
||||
<span class="doccomment">//! module author can add a simple shim to support the Web Cryptography API:</span>
|
||||
<span class="doccomment">//! ```js</span>
|
||||
<span class="doccomment">//! import { webcrypto } from 'node:crypto'</span>
|
||||
<span class="doccomment">//! globalThis.crypto = webcrypto</span>
|
||||
<span class="doccomment">//! ```</span>
|
||||
<span class="doccomment">//! This crate will then use the provided `webcrypto` implementation.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ### Custom implementations</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! The [`register_custom_getrandom!`] macro allows a user to mark their own</span>
|
||||
<span class="doccomment">//! function as the backing implementation for [`getrandom`]. See the macro's</span>
|
||||
<span class="doccomment">//! documentation for more information about writing and registering your own</span>
|
||||
<span class="doccomment">//! custom implementations.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Note that registering a custom implementation only has an effect on targets</span>
|
||||
<span class="doccomment">//! that would otherwise not compile. Any supported targets (including those</span>
|
||||
<span class="doccomment">//! using `rdrand` and `js` Cargo features) continue using their normal</span>
|
||||
<span class="doccomment">//! implementations even if a function is registered.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ## Early boot</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Sometimes, early in the boot process, the OS has not collected enough</span>
|
||||
<span class="doccomment">//! entropy to securely seed its RNG. This is especially common on virtual</span>
|
||||
<span class="doccomment">//! machines, where standard "random" events are hard to come by.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! Some operating system interfaces always block until the RNG is securely</span>
|
||||
<span class="doccomment">//! seeded. This can take anywhere from a few seconds to more than a minute.</span>
|
||||
<span class="doccomment">//! A few (Linux, NetBSD and Solaris) offer a choice between blocking and</span>
|
||||
<span class="doccomment">//! getting an error; in these cases, we always choose to block.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! On Linux (when the `getrandom` system call is not available), reading from</span>
|
||||
<span class="doccomment">//! `/dev/urandom` never blocks, even when the OS hasn't collected enough</span>
|
||||
<span class="doccomment">//! entropy yet. To avoid returning low-entropy bytes, we first poll</span>
|
||||
<span class="doccomment">//! `/dev/random` and only switch to `/dev/urandom` once this has succeeded.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! On OpenBSD, this kind of entropy accounting isn't available, and on</span>
|
||||
<span class="doccomment">//! NetBSD, blocking on it is discouraged. On these platforms, nonblocking</span>
|
||||
<span class="doccomment">//! interfaces are used, even when reliable entropy may not be available.</span>
|
||||
<span class="doccomment">//! On the platforms where it is used, the reliability of entropy accounting</span>
|
||||
<span class="doccomment">//! itself isn't free from controversy. This library provides randomness</span>
|
||||
<span class="doccomment">//! sourced according to the platform's best practices, but each platform has</span>
|
||||
<span class="doccomment">//! its own limits on the grade of randomness it can promise in environments</span>
|
||||
<span class="doccomment">//! with few sources of entropy.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! ## Error handling</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! We always choose failure over returning known insecure "random" bytes. In</span>
|
||||
<span class="doccomment">//! general, on supported platforms, failure is highly unlikely, though not</span>
|
||||
<span class="doccomment">//! impossible. If an error does occur, then it is likely that it will occur</span>
|
||||
<span class="doccomment">//! on every call to `getrandom`, hence after the first successful call one</span>
|
||||
<span class="doccomment">//! can be reasonably confident that no errors will occur.</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! [1]: http://man7.org/linux/man-pages/man2/getrandom.2.html</span>
|
||||
<span class="doccomment">//! [2]: http://man7.org/linux/man-pages/man4/urandom.4.html</span>
|
||||
<span class="doccomment">//! [3]: https://www.unix.com/man-page/mojave/2/getentropy/</span>
|
||||
<span class="doccomment">//! [4]: https://www.unix.com/man-page/mojave/4/random/</span>
|
||||
<span class="doccomment">//! [5]: https://www.freebsd.org/cgi/man.cgi?query=getrandom&manpath=FreeBSD+12.0-stable</span>
|
||||
<span class="doccomment">//! [6]: https://www.freebsd.org/cgi/man.cgi?query=random&sektion=4</span>
|
||||
<span class="doccomment">//! [7]: https://man.openbsd.org/getentropy.2</span>
|
||||
<span class="doccomment">//! [8]: https://man.netbsd.org/sysctl.7</span>
|
||||
<span class="doccomment">//! [9]: https://leaf.dragonflybsd.org/cgi/web-man?command=getrandom</span>
|
||||
<span class="doccomment">//! [10]: https://leaf.dragonflybsd.org/cgi/web-man?command=random&section=4</span>
|
||||
<span class="doccomment">//! [11]: https://docs.oracle.com/cd/E88353_01/html/E37841/getrandom-2.html</span>
|
||||
<span class="doccomment">//! [12]: https://docs.oracle.com/cd/E86824_01/html/E54777/random-7d.html</span>
|
||||
<span class="doccomment">//!</span>
|
||||
<span class="doccomment">//! [`BCryptGenRandom`]: https://docs.microsoft.com/en-us/windows/win32/api/bcrypt/nf-bcrypt-bcryptgenrandom</span>
|
||||
<span class="doccomment">//! [`Crypto.getRandomValues`]: https://www.w3.org/TR/WebCryptoAPI/#Crypto-method-getRandomValues</span>
|
||||
<span class="doccomment">//! [`RDRAND`]: https://software.intel.com/en-us/articles/intel-digital-random-number-generator-drng-software-implementation-guide</span>
|
||||
<span class="doccomment">//! [`SecRandomCopyBytes`]: https://developer.apple.com/documentation/security/1399291-secrandomcopybytes?language=objc</span>
|
||||
<span class="doccomment">//! [`cprng_draw`]: https://fuchsia.dev/fuchsia-src/zircon/syscalls/cprng_draw</span>
|
||||
<span class="doccomment">//! [`crypto.randomFillSync`]: https://nodejs.org/api/crypto.html#cryptorandomfillsyncbuffer-offset-size</span>
|
||||
<span class="doccomment">//! [`esp_fill_random`]: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/random.html#_CPPv415esp_fill_randomPv6size_t</span>
|
||||
<span class="doccomment">//! [`random_get`]: https://github.com/WebAssembly/WASI/blob/main/phases/snapshot/docs.md#-random_getbuf-pointeru8-buf_len-size---errno</span>
|
||||
<span class="doccomment">//! [WebAssembly support]: #webassembly-support</span>
|
||||
<span class="doccomment">//! [`wasm-bindgen`]: https://github.com/rustwasm/wasm-bindgen</span>
|
||||
<span class="doccomment">//! [`module`]: https://rustwasm.github.io/wasm-bindgen/reference/attributes/on-js-imports/module.html</span>
|
||||
<span class="doccomment">//! [CommonJS modules]: https://nodejs.org/api/modules.html</span>
|
||||
<span class="doccomment">//! [ES modules]: https://nodejs.org/api/esm.html</span>
|
||||
|
||||
<span class="attribute">#![<span class="ident">doc</span>(
|
||||
<span class="ident">html_logo_url</span> <span class="op">=</span> <span class="string">"https://www.rust-lang.org/logos/rust-logo-128x128-blk.png"</span>,
|
||||
<span class="ident">html_favicon_url</span> <span class="op">=</span> <span class="string">"https://www.rust-lang.org/favicon.ico"</span>,
|
||||
<span class="ident">html_root_url</span> <span class="op">=</span> <span class="string">"https://docs.rs/getrandom/0.2.8"</span>
|
||||
)]</span>
|
||||
<span class="attribute">#![<span class="ident">no_std</span>]</span>
|
||||
<span class="attribute">#![<span class="ident">warn</span>(<span class="ident">rust_2018_idioms</span>, <span class="ident">unused_lifetimes</span>, <span class="ident">missing_docs</span>)]</span>
|
||||
<span class="attribute">#![<span class="ident">cfg_attr</span>(<span class="ident">docsrs</span>, <span class="ident">feature</span>(<span class="ident">doc_cfg</span>))]</span>
|
||||
|
||||
<span class="attribute">#[<span class="ident">macro_use</span>]</span>
|
||||
<span class="kw">extern</span> <span class="kw">crate</span> <span class="ident">cfg_if</span>;
|
||||
|
||||
<span class="kw">mod</span> <span class="ident">error</span>;
|
||||
<span class="kw">mod</span> <span class="ident">util</span>;
|
||||
<span class="comment">// To prevent a breaking change when targets are added, we always export the</span>
|
||||
<span class="comment">// register_custom_getrandom macro, so old Custom RNG crates continue to build.</span>
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"custom"</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">custom</span>;
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"std"</span>)]</span>
|
||||
<span class="kw">mod</span> <span class="ident">error_impls</span>;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::error::Error</span>;
|
||||
|
||||
<span class="comment">// System-specific implementations.</span>
|
||||
<span class="comment">//</span>
|
||||
<span class="comment">// These should all provide getrandom_inner with the same signature as getrandom.</span>
|
||||
<span class="macro">cfg_if!</span> {
|
||||
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"emscripten"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"haiku"</span>,
|
||||
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"redox"</span>))]</span> {
|
||||
<span class="kw">mod</span> <span class="ident">util_libc</span>;
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"use_file.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"android"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>))]</span> {
|
||||
<span class="kw">mod</span> <span class="ident">util_libc</span>;
|
||||
<span class="kw">mod</span> <span class="ident">use_file</span>;
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"linux_android.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"illumos"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"solaris"</span>))]</span> {
|
||||
<span class="kw">mod</span> <span class="ident">util_libc</span>;
|
||||
<span class="kw">mod</span> <span class="ident">use_file</span>;
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"solaris_illumos.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>))]</span> {
|
||||
<span class="kw">mod</span> <span class="ident">util_libc</span>;
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"bsd_arandom.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"dragonfly"</span>)]</span> {
|
||||
<span class="kw">mod</span> <span class="ident">util_libc</span>;
|
||||
<span class="kw">mod</span> <span class="ident">use_file</span>;
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"dragonfly.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"fuchsia"</span>)]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"fuchsia.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"ios"</span>)]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"ios.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>)]</span> {
|
||||
<span class="kw">mod</span> <span class="ident">util_libc</span>;
|
||||
<span class="kw">mod</span> <span class="ident">use_file</span>;
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"macos.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"openbsd"</span>)]</span> {
|
||||
<span class="kw">mod</span> <span class="ident">util_libc</span>;
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"openbsd.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"wasi"</span>)]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"wasi.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"x86_64"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"hermit"</span>))]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"rdrand.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"vxworks"</span>)]</span> {
|
||||
<span class="kw">mod</span> <span class="ident">util_libc</span>;
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"vxworks.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"solid_asp3"</span>)]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"solid.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"espidf"</span>)]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"espidf.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">windows</span>)]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"windows.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"x86_64"</span>, <span class="ident">target_env</span> <span class="op">=</span> <span class="string">"sgx"</span>))]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"rdrand.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"rdrand"</span>,
|
||||
<span class="ident">any</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"x86_64"</span>, <span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"x86"</span>)))]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"rdrand.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"js"</span>,
|
||||
<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"wasm32"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"unknown"</span>))]</span> {
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"js.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"horizon"</span>, <span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"arm"</span>))]</span> {
|
||||
<span class="comment">// We check for target_arch = "arm" because the Nintendo Switch also</span>
|
||||
<span class="comment">// uses Horizon OS (it is aarch64).</span>
|
||||
<span class="kw">mod</span> <span class="ident">util_libc</span>;
|
||||
<span class="attribute">#[<span class="ident">path</span> <span class="op">=</span> <span class="string">"3ds.rs"</span>]</span> <span class="kw">mod</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">feature</span> <span class="op">=</span> <span class="string">"custom"</span>)]</span> {
|
||||
<span class="kw">use</span> <span class="ident">custom</span> <span class="kw">as</span> <span class="ident">imp</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"wasm32"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"unknown"</span>))]</span> {
|
||||
<span class="macro">compile_error!</span>(<span class="string">"the wasm32-unknown-unknown target is not supported by \
|
||||
default, you may need to enable the \"js\" feature. \
|
||||
For more information see: \
|
||||
https://docs.rs/getrandom/#webassembly-support"</span>);
|
||||
} <span class="kw">else</span> {
|
||||
<span class="macro">compile_error!</span>(<span class="string">"target is not supported, for more information see: \
|
||||
https://docs.rs/getrandom/#unsupported-targets"</span>);
|
||||
}
|
||||
}
|
||||
|
||||
<span class="doccomment">/// Fill `dest` with random bytes from the system's preferred random number</span>
|
||||
<span class="doccomment">/// source.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// This function returns an error on any failure, including partial reads. We</span>
|
||||
<span class="doccomment">/// make no guarantees regarding the contents of `dest` on error. If `dest` is</span>
|
||||
<span class="doccomment">/// empty, `getrandom` immediately returns success, making no calls to the</span>
|
||||
<span class="doccomment">/// underlying operating system.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// Blocking is possible, at least during early boot; see module documentation.</span>
|
||||
<span class="doccomment">///</span>
|
||||
<span class="doccomment">/// In general, `getrandom` will be fast enough for interactive usage, though</span>
|
||||
<span class="doccomment">/// significantly slower than a user-space CSPRNG; for the latter consider</span>
|
||||
<span class="doccomment">/// [`rand::thread_rng`](https://docs.rs/rand/*/rand/fn.thread_rng.html).</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">getrandom</span>(<span class="ident">dest</span>: <span class="kw-2">&mut</span> [<span class="ident">u8</span>]) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="kw">if</span> <span class="ident">dest</span>.<span class="ident">is_empty</span>() {
|
||||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(());
|
||||
}
|
||||
<span class="ident">imp::getrandom_inner</span>(<span class="ident">dest</span>)
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="getrandom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
98
doc/src/getrandom/linux_android.rs.html
Normal file
98
doc/src/getrandom/linux_android.rs.html
Normal file
@ -0,0 +1,98 @@
|
||||
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.8/src/linux_android.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>linux_android.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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="icon" href="https://www.rust-lang.org/favicon.ico"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" 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><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" 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><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../getrandom/index.html">
|
||||
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><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>
|
||||
</pre><pre class="rust"><code><span class="comment">// Copyright 2018 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="doccomment">//! Implementation for Linux / Android</span>
|
||||
<span class="kw">use</span> <span class="kw">crate</span>::{
|
||||
<span class="ident">util::LazyBool</span>,
|
||||
<span class="ident">util_libc</span>::{<span class="ident">last_os_error</span>, <span class="ident">sys_fill_exact</span>},
|
||||
{<span class="ident">use_file</span>, <span class="ident">Error</span>},
|
||||
};
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">getrandom_inner</span>(<span class="ident">dest</span>: <span class="kw-2">&mut</span> [<span class="ident">u8</span>]) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="comment">// getrandom(2) was introduced in Linux 3.17</span>
|
||||
<span class="kw">static</span> <span class="ident">HAS_GETRANDOM</span>: <span class="ident">LazyBool</span> <span class="op">=</span> <span class="ident">LazyBool::new</span>();
|
||||
<span class="kw">if</span> <span class="ident">HAS_GETRANDOM</span>.<span class="ident">unsync_init</span>(<span class="ident">is_getrandom_available</span>) {
|
||||
<span class="ident">sys_fill_exact</span>(<span class="ident">dest</span>, <span class="op">|</span><span class="ident">buf</span><span class="op">|</span> <span class="kw">unsafe</span> {
|
||||
<span class="ident">getrandom</span>(<span class="ident">buf</span>.<span class="ident">as_mut_ptr</span>() <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="ident">libc::c_void</span>, <span class="ident">buf</span>.<span class="ident">len</span>(), <span class="number">0</span>)
|
||||
})
|
||||
} <span class="kw">else</span> {
|
||||
<span class="ident">use_file::getrandom_inner</span>(<span class="ident">dest</span>)
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">fn</span> <span class="ident">is_getrandom_available</span>() -> <span class="ident">bool</span> {
|
||||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">getrandom</span>(<span class="ident">core::ptr::null_mut</span>(), <span class="number">0</span>, <span class="ident">libc::GRND_NONBLOCK</span>) };
|
||||
<span class="kw">if</span> <span class="ident">res</span> <span class="op"><</span> <span class="number">0</span> {
|
||||
<span class="kw">match</span> <span class="ident">last_os_error</span>().<span class="ident">raw_os_error</span>() {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">libc::ENOSYS</span>) => <span class="bool-val">false</span>, <span class="comment">// No kernel support</span>
|
||||
<span class="prelude-val">Some</span>(<span class="ident">libc::EPERM</span>) => <span class="bool-val">false</span>, <span class="comment">// Blocked by seccomp</span>
|
||||
<span class="kw">_</span> => <span class="bool-val">true</span>,
|
||||
}
|
||||
} <span class="kw">else</span> {
|
||||
<span class="bool-val">true</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">getrandom</span>(
|
||||
<span class="ident">buf</span>: <span class="kw-2">*mut</span> <span class="ident">libc::c_void</span>,
|
||||
<span class="ident">buflen</span>: <span class="ident">libc::size_t</span>,
|
||||
<span class="ident">flags</span>: <span class="ident">libc::c_uint</span>,
|
||||
) -> <span class="ident">libc::ssize_t</span> {
|
||||
<span class="ident">libc::syscall</span>(<span class="ident">libc::SYS_getrandom</span>, <span class="ident">buf</span>, <span class="ident">buflen</span>, <span class="ident">flags</span>) <span class="kw">as</span> <span class="ident">libc::ssize_t</span>
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="getrandom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
282
doc/src/getrandom/use_file.rs.html
Normal file
282
doc/src/getrandom/use_file.rs.html
Normal file
@ -0,0 +1,282 @@
|
||||
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.8/src/use_file.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>use_file.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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="icon" href="https://www.rust-lang.org/favicon.ico"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" 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><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" 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><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../getrandom/index.html">
|
||||
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><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>
|
||||
<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>
|
||||
</pre><pre class="rust"><code><span class="comment">// Copyright 2018 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="doccomment">//! Implementations that just need to read from a file</span>
|
||||
<span class="kw">use</span> <span class="kw">crate</span>::{
|
||||
<span class="ident">util::LazyUsize</span>,
|
||||
<span class="ident">util_libc</span>::{<span class="ident">open_readonly</span>, <span class="ident">sys_fill_exact</span>},
|
||||
<span class="ident">Error</span>,
|
||||
};
|
||||
<span class="kw">use</span> <span class="ident">core</span>::{
|
||||
<span class="ident">cell::UnsafeCell</span>,
|
||||
<span class="ident">sync::atomic</span>::{<span class="ident">AtomicUsize</span>, <span class="ident">Ordering::Relaxed</span>},
|
||||
};
|
||||
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(
|
||||
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"dragonfly"</span>,
|
||||
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"emscripten"</span>,
|
||||
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"haiku"</span>,
|
||||
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>,
|
||||
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"solaris"</span>,
|
||||
<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"illumos"</span>
|
||||
))]</span>
|
||||
<span class="kw">const</span> <span class="ident">FILE_PATH</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"/dev/random\0"</span>;
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"android"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"redox"</span>))]</span>
|
||||
<span class="kw">const</span> <span class="ident">FILE_PATH</span>: <span class="kw-2">&</span><span class="ident">str</span> <span class="op">=</span> <span class="string">"/dev/urandom\0"</span>;
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">getrandom_inner</span>(<span class="ident">dest</span>: <span class="kw-2">&mut</span> [<span class="ident">u8</span>]) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="kw">let</span> <span class="ident">fd</span> <span class="op">=</span> <span class="ident">get_rng_fd</span>()<span class="question-mark">?</span>;
|
||||
<span class="kw">let</span> <span class="ident">read</span> <span class="op">=</span> <span class="op">|</span><span class="ident">buf</span>: <span class="kw-2">&mut</span> [<span class="ident">u8</span>]<span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">libc::read</span>(<span class="ident">fd</span>, <span class="ident">buf</span>.<span class="ident">as_mut_ptr</span>() <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="kw">_</span>, <span class="ident">buf</span>.<span class="ident">len</span>()) };
|
||||
|
||||
<span class="kw">if</span> <span class="macro">cfg!</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"emscripten"</span>) {
|
||||
<span class="comment">// `Crypto.getRandomValues` documents `dest` should be at most 65536 bytes.</span>
|
||||
<span class="kw">for</span> <span class="ident">chunk</span> <span class="kw">in</span> <span class="ident">dest</span>.<span class="ident">chunks_mut</span>(<span class="number">65536</span>) {
|
||||
<span class="ident">sys_fill_exact</span>(<span class="ident">chunk</span>, <span class="ident">read</span>)<span class="question-mark">?</span>;
|
||||
}
|
||||
} <span class="kw">else</span> {
|
||||
<span class="ident">sys_fill_exact</span>(<span class="ident">dest</span>, <span class="ident">read</span>)<span class="question-mark">?</span>;
|
||||
}
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}
|
||||
|
||||
<span class="comment">// Returns the file descriptor for the device file used to retrieve random</span>
|
||||
<span class="comment">// bytes. The file will be opened exactly once. All subsequent calls will</span>
|
||||
<span class="comment">// return the same file descriptor. This file descriptor is never closed.</span>
|
||||
<span class="kw">fn</span> <span class="ident">get_rng_fd</span>() -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">libc::c_int</span>, <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="kw">static</span> <span class="ident">FD</span>: <span class="ident">AtomicUsize</span> <span class="op">=</span> <span class="ident">AtomicUsize::new</span>(<span class="ident">LazyUsize::UNINIT</span>);
|
||||
<span class="kw">fn</span> <span class="ident">get_fd</span>() -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">libc::c_int</span><span class="op">></span> {
|
||||
<span class="kw">match</span> <span class="ident">FD</span>.<span class="ident">load</span>(<span class="ident">Relaxed</span>) {
|
||||
<span class="ident">LazyUsize::UNINIT</span> => <span class="prelude-val">None</span>,
|
||||
<span class="ident">val</span> => <span class="prelude-val">Some</span>(<span class="ident">val</span> <span class="kw">as</span> <span class="ident">libc::c_int</span>),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="comment">// Use double-checked locking to avoid acquiring the lock if possible.</span>
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">fd</span>) <span class="op">=</span> <span class="ident">get_fd</span>() {
|
||||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">fd</span>);
|
||||
}
|
||||
|
||||
<span class="comment">// SAFETY: We use the mutex only in this method, and we always unlock it</span>
|
||||
<span class="comment">// before returning, making sure we don't violate the pthread_mutex_t API.</span>
|
||||
<span class="kw">static</span> <span class="ident">MUTEX</span>: <span class="ident">Mutex</span> <span class="op">=</span> <span class="ident">Mutex::new</span>();
|
||||
<span class="kw">unsafe</span> { <span class="ident">MUTEX</span>.<span class="ident">lock</span>() };
|
||||
<span class="kw">let</span> <span class="ident">_guard</span> <span class="op">=</span> <span class="ident">DropGuard</span>(<span class="op">|</span><span class="op">|</span> <span class="kw">unsafe</span> { <span class="ident">MUTEX</span>.<span class="ident">unlock</span>() });
|
||||
|
||||
<span class="kw">if</span> <span class="kw">let</span> <span class="prelude-val">Some</span>(<span class="ident">fd</span>) <span class="op">=</span> <span class="ident">get_fd</span>() {
|
||||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">fd</span>);
|
||||
}
|
||||
|
||||
<span class="comment">// On Linux, /dev/urandom might return insecure values.</span>
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"android"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>))]</span>
|
||||
<span class="ident">wait_until_rng_ready</span>()<span class="question-mark">?</span>;
|
||||
|
||||
<span class="kw">let</span> <span class="ident">fd</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">open_readonly</span>(<span class="ident">FILE_PATH</span>)<span class="question-mark">?</span> };
|
||||
<span class="comment">// The fd always fits in a usize without conflicting with UNINIT.</span>
|
||||
<span class="macro">debug_assert!</span>(<span class="ident">fd</span> <span class="op">></span><span class="op">=</span> <span class="number">0</span> <span class="op">&&</span> (<span class="ident">fd</span> <span class="kw">as</span> <span class="ident">usize</span>) <span class="op"><</span> <span class="ident">LazyUsize::UNINIT</span>);
|
||||
<span class="ident">FD</span>.<span class="ident">store</span>(<span class="ident">fd</span> <span class="kw">as</span> <span class="ident">usize</span>, <span class="ident">Relaxed</span>);
|
||||
|
||||
<span class="prelude-val">Ok</span>(<span class="ident">fd</span>)
|
||||
}
|
||||
|
||||
<span class="comment">// Succeeds once /dev/urandom is safe to read from</span>
|
||||
<span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"android"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>))]</span>
|
||||
<span class="kw">fn</span> <span class="ident">wait_until_rng_ready</span>() -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="comment">// Poll /dev/random to make sure it is ok to read from /dev/urandom.</span>
|
||||
<span class="kw">let</span> <span class="ident">fd</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">open_readonly</span>(<span class="string">"/dev/random\0"</span>)<span class="question-mark">?</span> };
|
||||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">pfd</span> <span class="op">=</span> <span class="ident">libc::pollfd</span> {
|
||||
<span class="ident">fd</span>,
|
||||
<span class="ident">events</span>: <span class="ident">libc::POLLIN</span>,
|
||||
<span class="ident">revents</span>: <span class="number">0</span>,
|
||||
};
|
||||
<span class="kw">let</span> <span class="ident">_guard</span> <span class="op">=</span> <span class="ident">DropGuard</span>(<span class="op">|</span><span class="op">|</span> <span class="kw">unsafe</span> {
|
||||
<span class="ident">libc::close</span>(<span class="ident">fd</span>);
|
||||
});
|
||||
|
||||
<span class="kw">loop</span> {
|
||||
<span class="comment">// A negative timeout means an infinite timeout.</span>
|
||||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">libc::poll</span>(<span class="kw-2">&mut</span> <span class="ident">pfd</span>, <span class="number">1</span>, <span class="op">-</span><span class="number">1</span>) };
|
||||
<span class="kw">if</span> <span class="ident">res</span> <span class="op">></span><span class="op">=</span> <span class="number">0</span> {
|
||||
<span class="macro">debug_assert_eq!</span>(<span class="ident">res</span>, <span class="number">1</span>); <span class="comment">// We only used one fd, and cannot timeout.</span>
|
||||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(());
|
||||
}
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident"><span class="kw">crate</span>::util_libc::last_os_error</span>();
|
||||
<span class="kw">match</span> <span class="ident">err</span>.<span class="ident">raw_os_error</span>() {
|
||||
<span class="prelude-val">Some</span>(<span class="ident">libc::EINTR</span>) <span class="op">|</span> <span class="prelude-val">Some</span>(<span class="ident">libc::EAGAIN</span>) => <span class="kw">continue</span>,
|
||||
<span class="kw">_</span> => <span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">err</span>),
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">struct</span> <span class="ident">Mutex</span>(<span class="ident">UnsafeCell</span><span class="op"><</span><span class="ident">libc::pthread_mutex_t</span><span class="op">></span>);
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Mutex</span> {
|
||||
<span class="kw">const</span> <span class="kw">fn</span> <span class="ident">new</span>() -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span>(<span class="ident">UnsafeCell::new</span>(<span class="ident">libc::PTHREAD_MUTEX_INITIALIZER</span>))
|
||||
}
|
||||
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">lock</span>(<span class="kw-2">&</span><span class="self">self</span>) {
|
||||
<span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="ident">libc::pthread_mutex_lock</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">get</span>());
|
||||
<span class="macro">debug_assert_eq!</span>(<span class="ident">r</span>, <span class="number">0</span>);
|
||||
}
|
||||
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">unlock</span>(<span class="kw-2">&</span><span class="self">self</span>) {
|
||||
<span class="kw">let</span> <span class="ident">r</span> <span class="op">=</span> <span class="ident">libc::pthread_mutex_unlock</span>(<span class="self">self</span>.<span class="number">0</span>.<span class="ident">get</span>());
|
||||
<span class="macro">debug_assert_eq!</span>(<span class="ident">r</span>, <span class="number">0</span>);
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">unsafe</span> <span class="kw">impl</span> <span class="ident">Sync</span> <span class="kw">for</span> <span class="ident">Mutex</span> {}
|
||||
|
||||
<span class="kw">struct</span> <span class="ident">DropGuard</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">FnMut</span>()<span class="op">></span>(<span class="ident">F</span>);
|
||||
|
||||
<span class="kw">impl</span><span class="op"><</span><span class="ident">F</span>: <span class="ident">FnMut</span>()<span class="op">></span> <span class="ident">Drop</span> <span class="kw">for</span> <span class="ident">DropGuard</span><span class="op"><</span><span class="ident">F</span><span class="op">></span> {
|
||||
<span class="kw">fn</span> <span class="ident">drop</span>(<span class="kw-2">&mut</span> <span class="self">self</span>) {
|
||||
<span class="self">self</span>.<span class="number">0</span>()
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="getrandom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
132
doc/src/getrandom/util.rs.html
Normal file
132
doc/src/getrandom/util.rs.html
Normal file
@ -0,0 +1,132 @@
|
||||
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.8/src/util.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>util.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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="icon" href="https://www.rust-lang.org/favicon.ico"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" 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><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" 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><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../getrandom/index.html">
|
||||
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><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>
|
||||
</pre><pre class="rust"><code><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="attribute">#![<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span>
|
||||
<span class="kw">use</span> <span class="ident">core::sync::atomic</span>::{<span class="ident">AtomicUsize</span>, <span class="ident">Ordering::Relaxed</span>};
|
||||
|
||||
<span class="comment">// This structure represents a lazily initialized static usize value. Useful</span>
|
||||
<span class="comment">// when it is preferable 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 synchronization 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="self">Self</span> {
|
||||
<span class="self">Self</span>(<span class="ident">AtomicUsize::new</span>(<span class="ident"><span class="self">Self</span>::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::max_value</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="ident">usize</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="ident"><span class="self">Self</span>::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">// 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="self">Self</span> {
|
||||
<span class="self">Self</span>(<span class="ident">LazyUsize::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="ident">bool</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="op">|</span> <span class="ident">init</span>() <span class="kw">as</span> <span class="ident">usize</span>) <span class="op">!</span><span class="op">=</span> <span class="number">0</span>
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="getrandom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
324
doc/src/getrandom/util_libc.rs.html
Normal file
324
doc/src/getrandom/util_libc.rs.html
Normal file
@ -0,0 +1,324 @@
|
||||
<!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 `/home/justine/.cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.8/src/util_libc.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>util_libc.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" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../../dark.css" disabled><link rel="stylesheet" type="text/css" 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="icon" href="https://www.rust-lang.org/favicon.ico"></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="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" 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><h2 class="location"></h2></nav><nav class="sidebar"><a class="sidebar-logo" 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><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../../getrandom/index.html">
|
||||
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><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"><button type="button">?</button></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></div><section id="main-content" class="content"><div class="example-wrap"><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>
|
||||
<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>
|
||||
</pre><pre class="rust"><code><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="attribute">#![<span class="ident">allow</span>(<span class="ident">dead_code</span>)]</span>
|
||||
<span class="kw">use</span> <span class="ident"><span class="kw">crate</span>::Error</span>;
|
||||
<span class="kw">use</span> <span class="ident">core</span>::{
|
||||
<span class="ident">num::NonZeroU32</span>,
|
||||
<span class="ident">ptr::NonNull</span>,
|
||||
<span class="ident">sync::atomic</span>::{<span class="ident">fence</span>, <span class="ident">AtomicPtr</span>, <span class="ident">Ordering</span>},
|
||||
};
|
||||
<span class="kw">use</span> <span class="ident">libc::c_void</span>;
|
||||
|
||||
<span class="macro">cfg_if!</span> {
|
||||
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"netbsd"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"openbsd"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"android"</span>))]</span> {
|
||||
<span class="kw">use</span> <span class="ident">libc::__errno</span> <span class="kw">as</span> <span class="ident">errno_location</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"emscripten"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"redox"</span>))]</span> {
|
||||
<span class="kw">use</span> <span class="ident">libc::__errno_location</span> <span class="kw">as</span> <span class="ident">errno_location</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"solaris"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"illumos"</span>))]</span> {
|
||||
<span class="kw">use</span> <span class="ident">libc::___errno</span> <span class="kw">as</span> <span class="ident">errno_location</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"macos"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"freebsd"</span>))]</span> {
|
||||
<span class="kw">use</span> <span class="ident">libc::__error</span> <span class="kw">as</span> <span class="ident">errno_location</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"haiku"</span>)]</span> {
|
||||
<span class="kw">use</span> <span class="ident">libc::_errnop</span> <span class="kw">as</span> <span class="ident">errno_location</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">all</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"horizon"</span>, <span class="ident">target_arch</span> <span class="op">=</span> <span class="string">"arm"</span>))]</span> {
|
||||
<span class="kw">extern</span> <span class="string">"C"</span> {
|
||||
<span class="comment">// Not provided by libc: https://github.com/rust-lang/libc/issues/1995</span>
|
||||
<span class="kw">fn</span> <span class="ident">__errno</span>() -> <span class="kw-2">*mut</span> <span class="ident">libc::c_int</span>;
|
||||
}
|
||||
<span class="kw">use</span> <span class="ident">__errno</span> <span class="kw">as</span> <span class="ident">errno_location</span>;
|
||||
}
|
||||
}
|
||||
|
||||
<span class="macro">cfg_if!</span> {
|
||||
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"vxworks"</span>)]</span> {
|
||||
<span class="kw">use</span> <span class="ident">libc::errnoGet</span> <span class="kw">as</span> <span class="ident">get_errno</span>;
|
||||
} <span class="kw">else</span> <span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"dragonfly"</span>)]</span> {
|
||||
<span class="comment">// Until rust-lang/rust#29594 is stable, we cannot get the errno value</span>
|
||||
<span class="comment">// on DragonFlyBSD. So we just return an out-of-range errno.</span>
|
||||
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">get_errno</span>() -> <span class="ident">libc::c_int</span> { <span class="op">-</span><span class="number">1</span> }
|
||||
} <span class="kw">else</span> {
|
||||
<span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">get_errno</span>() -> <span class="ident">libc::c_int</span> { <span class="kw-2">*</span><span class="ident">errno_location</span>() }
|
||||
}
|
||||
}
|
||||
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">last_os_error</span>() -> <span class="ident">Error</span> {
|
||||
<span class="kw">let</span> <span class="ident">errno</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">get_errno</span>() };
|
||||
<span class="kw">if</span> <span class="ident">errno</span> <span class="op">></span> <span class="number">0</span> {
|
||||
<span class="ident">Error::from</span>(<span class="ident">NonZeroU32::new</span>(<span class="ident">errno</span> <span class="kw">as</span> <span class="ident">u32</span>).<span class="ident">unwrap</span>())
|
||||
} <span class="kw">else</span> {
|
||||
<span class="ident">Error::ERRNO_NOT_POSITIVE</span>
|
||||
}
|
||||
}
|
||||
|
||||
<span class="comment">// Fill a buffer by repeatedly invoking a system call. The `sys_fill` function:</span>
|
||||
<span class="comment">// - should return -1 and set errno on failure</span>
|
||||
<span class="comment">// - should return the number of bytes written on success</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">sys_fill_exact</span>(
|
||||
<span class="kw-2">mut</span> <span class="ident">buf</span>: <span class="kw-2">&mut</span> [<span class="ident">u8</span>],
|
||||
<span class="ident">sys_fill</span>: <span class="kw">impl</span> <span class="ident">Fn</span>(<span class="kw-2">&mut</span> [<span class="ident">u8</span>]) -> <span class="ident">libc::ssize_t</span>,
|
||||
) -> <span class="prelude-ty">Result</span><span class="op"><</span>(), <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="kw">while</span> <span class="op">!</span><span class="ident">buf</span>.<span class="ident">is_empty</span>() {
|
||||
<span class="kw">let</span> <span class="ident">res</span> <span class="op">=</span> <span class="ident">sys_fill</span>(<span class="ident">buf</span>);
|
||||
<span class="kw">if</span> <span class="ident">res</span> <span class="op"><</span> <span class="number">0</span> {
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">last_os_error</span>();
|
||||
<span class="comment">// We should try again if the call was interrupted.</span>
|
||||
<span class="kw">if</span> <span class="ident">err</span>.<span class="ident">raw_os_error</span>() <span class="op">!</span><span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">libc::EINTR</span>) {
|
||||
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">err</span>);
|
||||
}
|
||||
} <span class="kw">else</span> {
|
||||
<span class="comment">// We don't check for EOF (ret = 0) as the data we are reading</span>
|
||||
<span class="comment">// should be an infinite stream of random bytes.</span>
|
||||
<span class="ident">buf</span> <span class="op">=</span> <span class="kw-2">&mut</span> <span class="ident">buf</span>[(<span class="ident">res</span> <span class="kw">as</span> <span class="ident">usize</span>)..];
|
||||
}
|
||||
}
|
||||
<span class="prelude-val">Ok</span>(())
|
||||
}
|
||||
|
||||
<span class="comment">// A "weak" binding to a C function that may or may not be present at runtime.</span>
|
||||
<span class="comment">// Used for supporting newer OS features while still building on older systems.</span>
|
||||
<span class="comment">// Based off of the DlsymWeak struct in libstd:</span>
|
||||
<span class="comment">// https://github.com/rust-lang/rust/blob/1.61.0/library/std/src/sys/unix/weak.rs#L84</span>
|
||||
<span class="comment">// except that the caller must manually cast self.ptr() to a function pointer.</span>
|
||||
<span class="kw">pub</span> <span class="kw">struct</span> <span class="ident">Weak</span> {
|
||||
<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>,
|
||||
<span class="ident">addr</span>: <span class="ident">AtomicPtr</span><span class="op"><</span><span class="ident">c_void</span><span class="op">></span>,
|
||||
}
|
||||
|
||||
<span class="kw">impl</span> <span class="ident">Weak</span> {
|
||||
<span class="comment">// A non-null pointer value which indicates we are uninitialized. This</span>
|
||||
<span class="comment">// constant should ideally not be a valid address of a function pointer.</span>
|
||||
<span class="comment">// However, if by chance libc::dlsym does return UNINIT, there will not</span>
|
||||
<span class="comment">// be undefined behavior. libc::dlsym will just be called each time ptr()</span>
|
||||
<span class="comment">// is called. This would be inefficient, but correct.</span>
|
||||
<span class="comment">// TODO: Replace with core::ptr::invalid_mut(1) when that is stable.</span>
|
||||
<span class="kw">const</span> <span class="ident">UNINIT</span>: <span class="kw-2">*mut</span> <span class="ident">c_void</span> <span class="op">=</span> <span class="number">1</span> <span class="kw">as</span> <span class="kw-2">*mut</span> <span class="ident">c_void</span>;
|
||||
|
||||
<span class="comment">// Construct a binding to a C function with a given name. This function is</span>
|
||||
<span class="comment">// unsafe because `name` _must_ be null terminated.</span>
|
||||
<span class="kw">pub</span> <span class="kw">const</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">new</span>(<span class="ident">name</span>: <span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span>) -> <span class="self">Self</span> {
|
||||
<span class="self">Self</span> {
|
||||
<span class="ident">name</span>,
|
||||
<span class="ident">addr</span>: <span class="ident">AtomicPtr::new</span>(<span class="ident"><span class="self">Self</span>::UNINIT</span>),
|
||||
}
|
||||
}
|
||||
|
||||
<span class="comment">// Return the address of a function if present at runtime. Otherwise,</span>
|
||||
<span class="comment">// return None. Multiple callers can call ptr() concurrently. It will</span>
|
||||
<span class="comment">// always return _some_ value returned by libc::dlsym. However, the</span>
|
||||
<span class="comment">// dlsym function may be called multiple times.</span>
|
||||
<span class="kw">pub</span> <span class="kw">fn</span> <span class="ident">ptr</span>(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><span class="op"><</span><span class="ident">NonNull</span><span class="op"><</span><span class="ident">c_void</span><span class="op">></span><span class="op">></span> {
|
||||
<span class="comment">// Despite having only a single atomic variable (self.addr), we still</span>
|
||||
<span class="comment">// cannot always use Ordering::Relaxed, as we need to make sure a</span>
|
||||
<span class="comment">// successful call to dlsym() is "ordered before" any data read through</span>
|
||||
<span class="comment">// the returned pointer (which occurs when the function is called).</span>
|
||||
<span class="comment">// Our implementation mirrors that of the one in libstd, meaning that</span>
|
||||
<span class="comment">// the use of non-Relaxed operations is probably unnecessary.</span>
|
||||
<span class="kw">match</span> <span class="self">self</span>.<span class="ident">addr</span>.<span class="ident">load</span>(<span class="ident">Ordering::Relaxed</span>) {
|
||||
<span class="ident"><span class="self">Self</span>::UNINIT</span> => {
|
||||
<span class="kw">let</span> <span class="ident">symbol</span> <span class="op">=</span> <span class="self">self</span>.<span class="ident">name</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*const</span> <span class="kw">_</span>;
|
||||
<span class="kw">let</span> <span class="ident">addr</span> <span class="op">=</span> <span class="kw">unsafe</span> { <span class="ident">libc::dlsym</span>(<span class="ident">libc::RTLD_DEFAULT</span>, <span class="ident">symbol</span>) };
|
||||
<span class="comment">// Synchronizes with the Acquire fence below</span>
|
||||
<span class="self">self</span>.<span class="ident">addr</span>.<span class="ident">store</span>(<span class="ident">addr</span>, <span class="ident">Ordering::Release</span>);
|
||||
<span class="ident">NonNull::new</span>(<span class="ident">addr</span>)
|
||||
}
|
||||
<span class="ident">addr</span> => {
|
||||
<span class="kw">let</span> <span class="ident">func</span> <span class="op">=</span> <span class="ident">NonNull::new</span>(<span class="ident">addr</span>)<span class="question-mark">?</span>;
|
||||
<span class="ident">fence</span>(<span class="ident">Ordering::Acquire</span>);
|
||||
<span class="prelude-val">Some</span>(<span class="ident">func</span>)
|
||||
}
|
||||
}
|
||||
}
|
||||
}
|
||||
|
||||
<span class="macro">cfg_if!</span> {
|
||||
<span class="kw">if</span> <span class="attribute">#[<span class="ident">cfg</span>(<span class="ident">any</span>(<span class="ident">target_os</span> <span class="op">=</span> <span class="string">"linux"</span>, <span class="ident">target_os</span> <span class="op">=</span> <span class="string">"emscripten"</span>))]</span> {
|
||||
<span class="kw">use</span> <span class="ident">libc::open64</span> <span class="kw">as</span> <span class="ident">open</span>;
|
||||
} <span class="kw">else</span> {
|
||||
<span class="kw">use</span> <span class="ident">libc::open</span>;
|
||||
}
|
||||
}
|
||||
|
||||
<span class="comment">// SAFETY: path must be null terminated, FD must be manually closed.</span>
|
||||
<span class="kw">pub</span> <span class="kw">unsafe</span> <span class="kw">fn</span> <span class="ident">open_readonly</span>(<span class="ident">path</span>: <span class="kw-2">&</span><span class="ident">str</span>) -> <span class="prelude-ty">Result</span><span class="op"><</span><span class="ident">libc::c_int</span>, <span class="ident">Error</span><span class="op">></span> {
|
||||
<span class="macro">debug_assert_eq!</span>(<span class="ident">path</span>.<span class="ident">as_bytes</span>().<span class="ident">last</span>(), <span class="prelude-val">Some</span>(<span class="kw-2">&</span><span class="number">0</span>));
|
||||
<span class="kw">loop</span> {
|
||||
<span class="kw">let</span> <span class="ident">fd</span> <span class="op">=</span> <span class="ident">open</span>(<span class="ident">path</span>.<span class="ident">as_ptr</span>() <span class="kw">as</span> <span class="kw-2">*const</span> <span class="kw">_</span>, <span class="ident">libc::O_RDONLY</span> <span class="op">|</span> <span class="ident">libc::O_CLOEXEC</span>);
|
||||
<span class="kw">if</span> <span class="ident">fd</span> <span class="op">></span><span class="op">=</span> <span class="number">0</span> {
|
||||
<span class="kw">return</span> <span class="prelude-val">Ok</span>(<span class="ident">fd</span>);
|
||||
}
|
||||
<span class="kw">let</span> <span class="ident">err</span> <span class="op">=</span> <span class="ident">last_os_error</span>();
|
||||
<span class="comment">// We should try again if open() was interrupted.</span>
|
||||
<span class="kw">if</span> <span class="ident">err</span>.<span class="ident">raw_os_error</span>() <span class="op">!</span><span class="op">=</span> <span class="prelude-val">Some</span>(<span class="ident">libc::EINTR</span>) {
|
||||
<span class="kw">return</span> <span class="prelude-val">Err</span>(<span class="ident">err</span>);
|
||||
}
|
||||
}
|
||||
}
|
||||
</code></pre></div>
|
||||
</section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="getrandom" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.64.0 (a55dd71d5 2022-09-19)" ></div></body></html>
|
||||
Reference in New Issue
Block a user