diff options
| author | garhve <git@garhve.com> | 2022-12-20 11:04:25 +0800 |
|---|---|---|
| committer | garhve <git@garhve.com> | 2022-12-20 11:04:25 +0800 |
| commit | 369d11587339ce74f8ebc76f2607fe55545eaf7d (patch) | |
| tree | 4b25c6f7e3aca08a90b25950f4f8e4430c4294bc /rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom | |
| parent | 0f1b6d015243e55a38b1c1b7e8af66668e4e794d (diff) | |
Build small project following the book
Diffstat (limited to 'rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom')
7 files changed, 1853 insertions, 0 deletions
diff --git a/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/error.rs.html b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/error.rs.html new file mode 100644 index 0000000..4f73e10 --- /dev/null +++ b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/error.rs.html @@ -0,0 +1,385 @@ +<!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/pico/.local/share/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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="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="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><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><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> +<span id="2">2</span> +<span id="3">3</span> +<span id="4">4</span> +<span id="5">5</span> +<span id="6">6</span> +<span id="7">7</span> +<span id="8">8</span> +<span id="9">9</span> +<span id="10">10</span> +<span id="11">11</span> +<span id="12">12</span> +<span id="13">13</span> +<span id="14">14</span> +<span id="15">15</span> +<span id="16">16</span> +<span id="17">17</span> +<span id="18">18</span> +<span id="19">19</span> +<span id="20">20</span> +<span id="21">21</span> +<span id="22">22</span> +<span id="23">23</span> +<span id="24">24</span> +<span id="25">25</span> +<span id="26">26</span> +<span id="27">27</span> +<span id="28">28</span> +<span id="29">29</span> +<span id="30">30</span> +<span id="31">31</span> +<span id="32">32</span> +<span id="33">33</span> +<span id="34">34</span> +<span id="35">35</span> +<span id="36">36</span> +<span id="37">37</span> +<span id="38">38</span> +<span id="39">39</span> +<span id="40">40</span> +<span id="41">41</span> +<span id="42">42</span> +<span id="43">43</span> +<span id="44">44</span> +<span id="45">45</span> +<span id="46">46</span> +<span id="47">47</span> +<span id="48">48</span> +<span id="49">49</span> +<span id="50">50</span> +<span id="51">51</span> +<span id="52">52</span> +<span id="53">53</span> +<span id="54">54</span> +<span id="55">55</span> +<span id="56">56</span> +<span id="57">57</span> +<span id="58">58</span> +<span id="59">59</span> +<span id="60">60</span> +<span id="61">61</span> +<span id="62">62</span> +<span id="63">63</span> +<span id="64">64</span> +<span id="65">65</span> +<span id="66">66</span> +<span id="67">67</span> +<span id="68">68</span> +<span id="69">69</span> +<span id="70">70</span> +<span id="71">71</span> +<span id="72">72</span> +<span id="73">73</span> +<span id="74">74</span> +<span id="75">75</span> +<span id="76">76</span> +<span id="77">77</span> +<span id="78">78</span> +<span id="79">79</span> +<span id="80">80</span> +<span id="81">81</span> +<span id="82">82</span> +<span id="83">83</span> +<span id="84">84</span> +<span id="85">85</span> +<span id="86">86</span> +<span id="87">87</span> +<span id="88">88</span> +<span id="89">89</span> +<span id="90">90</span> +<span id="91">91</span> +<span id="92">92</span> +<span id="93">93</span> +<span id="94">94</span> +<span id="95">95</span> +<span id="96">96</span> +<span id="97">97</span> +<span id="98">98</span> +<span id="99">99</span> +<span id="100">100</span> +<span id="101">101</span> +<span id="102">102</span> +<span id="103">103</span> +<span id="104">104</span> +<span id="105">105</span> +<span id="106">106</span> +<span id="107">107</span> +<span id="108">108</span> +<span id="109">109</span> +<span id="110">110</span> +<span id="111">111</span> +<span id="112">112</span> +<span id="113">113</span> +<span id="114">114</span> +<span id="115">115</span> +<span id="116">116</span> +<span id="117">117</span> +<span id="118">118</span> +<span id="119">119</span> +<span id="120">120</span> +<span id="121">121</span> +<span id="122">122</span> +<span id="123">123</span> +<span id="124">124</span> +<span id="125">125</span> +<span id="126">126</span> +<span id="127">127</span> +<span id="128">128</span> +<span id="129">129</span> +<span id="130">130</span> +<span id="131">131</span> +<span id="132">132</span> +<span id="133">133</span> +<span id="134">134</span> +<span id="135">135</span> +<span id="136">136</span> +<span id="137">137</span> +<span id="138">138</span> +<span id="139">139</span> +<span id="140">140</span> +<span id="141">141</span> +<span id="142">142</span> +<span id="143">143</span> +<span id="144">144</span> +<span id="145">145</span> +<span id="146">146</span> +<span id="147">147</span> +<span id="148">148</span> +<span id="149">149</span> +<span id="150">150</span> +<span id="151">151</span> +<span id="152">152</span> +<span id="153">153</span> +<span id="154">154</span> +<span id="155">155</span> +<span id="156">156</span> +<span id="157">157</span> +<span id="158">158</span> +<span id="159">159</span> +<span id="160">160</span> +<span id="161">161</span> +<span id="162">162</span> +<span id="163">163</span> +<span id="164">164</span> +<span id="165">165</span> +<span id="166">166</span> +<span id="167">167</span> +<span id="168">168</span> +<span id="169">169</span> +<span id="170">170</span> +<span id="171">171</span> +<span id="172">172</span> +<span id="173">173</span> +<span id="174">174</span> +<span id="175">175</span> +<span id="176">176</span> +<span id="177">177</span> +<span id="178">178</span> +<span id="179">179</span> +<span id="180">180</span> +<span id="181">181</span> +<span id="182">182</span> +<span id="183">183</span> +<span id="184">184</span> +<span id="185">185</span> +<span id="186">186</span> +<span id="187">187</span> +<span id="188">188</span> +<span id="189">189</span> +<span id="190">190</span> +<span id="191">191</span> +</pre><pre class="rust"><code><span class="comment">// Copyright 2018 Developers of the Rand project. +// +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or +// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license +// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. +</span><span class="kw">use </span>core::{fmt, num::NonZeroU32}; + +<span class="doccomment">/// A small and `no_std` compatible error type +/// +/// The [`Error::raw_os_error()`] will indicate if the error is from the OS, and +/// if so, which error code the OS gave the application. If such an error is +/// encountered, please consult with your system documentation. +/// +/// Internally this type is a NonZeroU32, with certain values reserved for +/// certain purposes, see [`Error::INTERNAL_START`] and [`Error::CUSTOM_START`]. +/// +/// *If this crate's `"std"` Cargo feature is enabled*, then: +/// - [`getrandom::Error`][Error] implements +/// [`std::error::Error`](https://doc.rust-lang.org/std/error/trait.Error.html) +/// - [`std::io::Error`](https://doc.rust-lang.org/std/io/struct.Error.html) implements +/// [`From<getrandom::Error>`](https://doc.rust-lang.org/std/convert/trait.From.html). +</span><span class="attribute">#[derive(Copy, Clone, Eq, PartialEq)] +</span><span class="kw">pub struct </span>Error(NonZeroU32); + +<span class="kw">const fn </span>internal_error(n: u16) -> Error { + <span class="comment">// SAFETY: code > 0 as INTERNAL_START > 0 and adding n won't overflow a u32. + </span><span class="kw">let </span>code = Error::INTERNAL_START + (n <span class="kw">as </span>u32); + Error(<span class="kw">unsafe </span>{ NonZeroU32::new_unchecked(code) }) +} + +<span class="kw">impl </span>Error { + <span class="doccomment">/// This target/platform is not supported by `getrandom`. + </span><span class="kw">pub const </span>UNSUPPORTED: Error = internal_error(<span class="number">0</span>); + <span class="doccomment">/// The platform-specific `errno` returned a non-positive value. + </span><span class="kw">pub const </span>ERRNO_NOT_POSITIVE: Error = internal_error(<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 const </span>IOS_SEC_RANDOM: Error = internal_error(<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 const </span>WINDOWS_RTL_GEN_RANDOM: Error = internal_error(<span class="number">4</span>); + <span class="doccomment">/// RDRAND instruction failed due to a hardware issue. + </span><span class="kw">pub const </span>FAILED_RDRAND: Error = internal_error(<span class="number">5</span>); + <span class="doccomment">/// RDRAND instruction unsupported on this target. + </span><span class="kw">pub const </span>NO_RDRAND: Error = internal_error(<span class="number">6</span>); + <span class="doccomment">/// The environment does not support the Web Crypto API. + </span><span class="kw">pub const </span>WEB_CRYPTO: Error = internal_error(<span class="number">7</span>); + <span class="doccomment">/// Calling Web Crypto API `crypto.getRandomValues` failed. + </span><span class="kw">pub const </span>WEB_GET_RANDOM_VALUES: Error = internal_error(<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 const </span>VXWORKS_RAND_SECURE: Error = internal_error(<span class="number">11</span>); + <span class="doccomment">/// Node.js does not have the `crypto` CommonJS module. + </span><span class="kw">pub const </span>NODE_CRYPTO: Error = internal_error(<span class="number">12</span>); + <span class="doccomment">/// Calling Node.js function `crypto.randomFillSync` failed. + </span><span class="kw">pub const </span>NODE_RANDOM_FILL_SYNC: Error = internal_error(<span class="number">13</span>); + <span class="doccomment">/// Called from an ES module on Node.js. This is unsupported, see: + /// <https://docs.rs/getrandom#nodejs-es-module-support>. + </span><span class="kw">pub const </span>NODE_ES_MODULE: Error = internal_error(<span class="number">14</span>); + + <span class="doccomment">/// Codes below this point represent OS Errors (i.e. positive i32 values). + /// Codes at or above this point, but below [`Error::CUSTOM_START`] are + /// reserved for use by the `rand` and `getrandom` crates. + </span><span class="kw">pub const </span>INTERNAL_START: u32 = <span class="number">1 </span><< <span class="number">31</span>; + + <span class="doccomment">/// Codes at or above this point can be used by users to define their own + /// custom errors. + </span><span class="kw">pub const </span>CUSTOM_START: u32 = (<span class="number">1 </span><< <span class="number">31</span>) + (<span class="number">1 </span><< <span class="number">30</span>); + + <span class="doccomment">/// Extract the raw OS error code (if this error came from the OS) + /// + /// This method is identical to [`std::io::Error::raw_os_error()`][1], except + /// that it works in `no_std` contexts. If this method returns `None`, the + /// error value can still be formatted via the `Display` implementation. + /// + /// [1]: https://doc.rust-lang.org/std/io/struct.Error.html#method.raw_os_error + </span><span class="attribute">#[inline] + </span><span class="kw">pub fn </span>raw_os_error(<span class="self">self</span>) -> <span class="prelude-ty">Option</span><i32> { + <span class="kw">if </span><span class="self">self</span>.<span class="number">0</span>.get() < <span class="self">Self</span>::INTERNAL_START { + <span class="kw">match </span>() { + <span class="attribute">#[cfg(target_os = <span class="string">"solid_asp3"</span>)] + </span><span class="comment">// On SOLID, negate the error code again to obtain the original + // error code. + </span>() => <span class="prelude-val">Some</span>(-(<span class="self">self</span>.<span class="number">0</span>.get() <span class="kw">as </span>i32)), + <span class="attribute">#[cfg(not(target_os = <span class="string">"solid_asp3"</span>))] + </span>() => <span class="prelude-val">Some</span>(<span class="self">self</span>.<span class="number">0</span>.get() <span class="kw">as </span>i32), + } + } <span class="kw">else </span>{ + <span class="prelude-val">None + </span>} + } + + <span class="doccomment">/// Extract the bare error code. + /// + /// This code can either come from the underlying OS, or be a custom error. + /// Use [`Error::raw_os_error()`] to disambiguate. + </span><span class="attribute">#[inline] + </span><span class="kw">pub const fn </span>code(<span class="self">self</span>) -> NonZeroU32 { + <span class="self">self</span>.<span class="number">0 + </span>} +} + +<span class="macro">cfg_if! </span>{ + <span class="kw">if </span><span class="attribute">#[cfg(unix)] </span>{ + <span class="kw">fn </span>os_err(errno: i32, buf: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> { + <span class="kw">let </span>buf_ptr = buf.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span>libc::c_char; + <span class="kw">if unsafe </span>{ libc::strerror_r(errno, buf_ptr, buf.len()) } != <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>n = buf.len(); + <span class="kw">let </span>idx = buf.iter().position(|<span class="kw-2">&</span>b| b == <span class="number">0</span>).unwrap_or(n); + core::str::from_utf8(<span class="kw-2">&</span>buf[..idx]).ok() + } + } <span class="kw">else </span>{ + <span class="kw">fn </span>os_err(_errno: i32, _buf: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>str> { + <span class="prelude-val">None + </span>} + } +} + +<span class="kw">impl </span>fmt::Debug <span class="kw">for </span>Error { + <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { + <span class="kw">let </span><span class="kw-2">mut </span>dbg = f.debug_struct(<span class="string">"Error"</span>); + <span class="kw">if let </span><span class="prelude-val">Some</span>(errno) = <span class="self">self</span>.raw_os_error() { + dbg.field(<span class="string">"os_error"</span>, <span class="kw-2">&</span>errno); + <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0u8</span>; <span class="number">128</span>]; + <span class="kw">if let </span><span class="prelude-val">Some</span>(err) = os_err(errno, <span class="kw-2">&mut </span>buf) { + dbg.field(<span class="string">"description"</span>, <span class="kw-2">&</span>err); + } + } <span class="kw">else if let </span><span class="prelude-val">Some</span>(desc) = internal_desc(<span class="kw-2">*</span><span class="self">self</span>) { + dbg.field(<span class="string">"internal_code"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>.get()); + dbg.field(<span class="string">"description"</span>, <span class="kw-2">&</span>desc); + } <span class="kw">else </span>{ + dbg.field(<span class="string">"unknown_code"</span>, <span class="kw-2">&</span><span class="self">self</span>.<span class="number">0</span>.get()); + } + dbg.finish() + } +} + +<span class="kw">impl </span>fmt::Display <span class="kw">for </span>Error { + <span class="kw">fn </span>fmt(<span class="kw-2">&</span><span class="self">self</span>, f: <span class="kw-2">&mut </span>fmt::Formatter<<span class="lifetime">'_</span>>) -> fmt::Result { + <span class="kw">if let </span><span class="prelude-val">Some</span>(errno) = <span class="self">self</span>.raw_os_error() { + <span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0u8</span>; <span class="number">128</span>]; + <span class="kw">match </span>os_err(errno, <span class="kw-2">&mut </span>buf) { + <span class="prelude-val">Some</span>(err) => err.fmt(f), + <span class="prelude-val">None </span>=> <span class="macro">write!</span>(f, <span class="string">"OS Error: {}"</span>, errno), + } + } <span class="kw">else if let </span><span class="prelude-val">Some</span>(desc) = internal_desc(<span class="kw-2">*</span><span class="self">self</span>) { + f.write_str(desc) + } <span class="kw">else </span>{ + <span class="macro">write!</span>(f, <span class="string">"Unknown Error: {}"</span>, <span class="self">self</span>.<span class="number">0</span>.get()) + } + } +} + +<span class="kw">impl </span>From<NonZeroU32> <span class="kw">for </span>Error { + <span class="kw">fn </span>from(code: NonZeroU32) -> <span class="self">Self </span>{ + <span class="self">Self</span>(code) + } +} + +<span class="kw">fn </span>internal_desc(error: Error) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span><span class="lifetime">'static </span>str> { + <span class="kw">match </span>error { + Error::UNSUPPORTED => <span class="prelude-val">Some</span>(<span class="string">"getrandom: this target is not supported"</span>), + Error::ERRNO_NOT_POSITIVE => <span class="prelude-val">Some</span>(<span class="string">"errno: did not return a positive value"</span>), + Error::IOS_SEC_RANDOM => <span class="prelude-val">Some</span>(<span class="string">"SecRandomCopyBytes: iOS Security framework failure"</span>), + Error::WINDOWS_RTL_GEN_RANDOM => <span class="prelude-val">Some</span>(<span class="string">"RtlGenRandom: Windows system function failure"</span>), + Error::FAILED_RDRAND => <span class="prelude-val">Some</span>(<span class="string">"RDRAND: failed multiple times: CPU issue likely"</span>), + Error::NO_RDRAND => <span class="prelude-val">Some</span>(<span class="string">"RDRAND: instruction not supported"</span>), + Error::WEB_CRYPTO => <span class="prelude-val">Some</span>(<span class="string">"Web Crypto API is unavailable"</span>), + Error::WEB_GET_RANDOM_VALUES => <span class="prelude-val">Some</span>(<span class="string">"Calling Web API crypto.getRandomValues failed"</span>), + Error::VXWORKS_RAND_SECURE => <span class="prelude-val">Some</span>(<span class="string">"randSecure: VxWorks RNG module is not initialized"</span>), + Error::NODE_CRYPTO => <span class="prelude-val">Some</span>(<span class="string">"Node.js crypto CommonJS module is unavailable"</span>), + Error::NODE_RANDOM_FILL_SYNC => <span class="prelude-val">Some</span>(<span class="string">"Calling Node.js API crypto.randomFillSync failed"</span>), + Error::NODE_ES_MODULE => <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">#[cfg(test)] +</span><span class="kw">mod </span>tests { + <span class="kw">use </span><span class="kw">super</span>::Error; + <span class="kw">use </span>core::mem::size_of; + + <span class="attribute">#[test] + </span><span class="kw">fn </span>test_size() { + <span class="macro">assert_eq!</span>(size_of::<Error>(), <span class="number">4</span>); + <span class="macro">assert_eq!</span>(size_of::<<span class="prelude-ty">Result</span><(), Error>>(), <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.66.0 (69f9c33d7 2022-12-12) (Arch Linux rust 1:1.66.0-1)" ></div></body></html>
\ No newline at end of file diff --git a/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/error_impls.rs.html b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/error_impls.rs.html new file mode 100644 index 0000000..8312fb2 --- /dev/null +++ b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/error_impls.rs.html @@ -0,0 +1,51 @@ +<!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/pico/.local/share/cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.8/src/error_impls.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>error_impls.rs - source</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="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="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><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><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> +<span id="2">2</span> +<span id="3">3</span> +<span id="4">4</span> +<span id="5">5</span> +<span id="6">6</span> +<span id="7">7</span> +<span id="8">8</span> +<span id="9">9</span> +<span id="10">10</span> +<span id="11">11</span> +<span id="12">12</span> +<span id="13">13</span> +<span id="14">14</span> +<span id="15">15</span> +<span id="16">16</span> +<span id="17">17</span> +<span id="18">18</span> +<span id="19">19</span> +<span id="20">20</span> +<span id="21">21</span> +<span id="22">22</span> +<span id="23">23</span> +<span id="24">24</span> +</pre><pre class="rust"><code><span class="comment">// Copyright 2018 Developers of the Rand project. +// +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or +// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license +// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. +</span><span class="attribute">#![cfg_attr(docsrs, doc(cfg(feature = <span class="string">"std"</span>)))] +</span><span class="kw">extern crate </span>std; + +<span class="kw">use </span><span class="kw">crate</span>::Error; +<span class="kw">use </span>core::convert::From; +<span class="kw">use </span>std::io; + +<span class="kw">impl </span>From<Error> <span class="kw">for </span>io::Error { + <span class="kw">fn </span>from(err: Error) -> <span class="self">Self </span>{ + <span class="kw">match </span>err.raw_os_error() { + <span class="prelude-val">Some</span>(errno) => io::Error::from_raw_os_error(errno), + <span class="prelude-val">None </span>=> io::Error::new(io::ErrorKind::Other, err), + } + } +} + +<span class="kw">impl </span>std::error::Error <span class="kw">for </span>Error {} +</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.66.0 (69f9c33d7 2022-12-12) (Arch Linux rust 1:1.66.0-1)" ></div></body></html>
\ No newline at end of file diff --git a/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/lib.rs.html b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/lib.rs.html new file mode 100644 index 0000000..1ee8d19 --- /dev/null +++ b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/lib.rs.html @@ -0,0 +1,585 @@ +<!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/pico/.local/share/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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="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="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><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><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> +<span id="2">2</span> +<span id="3">3</span> +<span id="4">4</span> +<span id="5">5</span> +<span id="6">6</span> +<span id="7">7</span> +<span id="8">8</span> +<span id="9">9</span> +<span id="10">10</span> +<span id="11">11</span> +<span id="12">12</span> +<span id="13">13</span> +<span id="14">14</span> +<span id="15">15</span> +<span id="16">16</span> +<span id="17">17</span> +<span id="18">18</span> +<span id="19">19</span> +<span id="20">20</span> +<span id="21">21</span> +<span id="22">22</span> +<span id="23">23</span> +<span id="24">24</span> +<span id="25">25</span> +<span id="26">26</span> +<span id="27">27</span> +<span id="28">28</span> +<span id="29">29</span> +<span id="30">30</span> +<span id="31">31</span> +<span id="32">32</span> +<span id="33">33</span> +<span id="34">34</span> +<span id="35">35</span> +<span id="36">36</span> +<span id="37">37</span> +<span id="38">38</span> +<span id="39">39</span> +<span id="40">40</span> +<span id="41">41</span> +<span id="42">42</span> +<span id="43">43</span> +<span id="44">44</span> +<span id="45">45</span> +<span id="46">46</span> +<span id="47">47</span> +<span id="48">48</span> +<span id="49">49</span> +<span id="50">50</span> +<span id="51">51</span> +<span id="52">52</span> +<span id="53">53</span> +<span id="54">54</span> +<span id="55">55</span> +<span id="56">56</span> +<span id="57">57</span> +<span id="58">58</span> +<span id="59">59</span> +<span id="60">60</span> +<span id="61">61</span> +<span id="62">62</span> +<span id="63">63</span> +<span id="64">64</span> +<span id="65">65</span> +<span id="66">66</span> +<span id="67">67</span> +<span id="68">68</span> +<span id="69">69</span> +<span id="70">70</span> +<span id="71">71</span> +<span id="72">72</span> +<span id="73">73</span> +<span id="74">74</span> +<span id="75">75</span> +<span id="76">76</span> +<span id="77">77</span> +<span id="78">78</span> +<span id="79">79</span> +<span id="80">80</span> +<span id="81">81</span> +<span id="82">82</span> +<span id="83">83</span> +<span id="84">84</span> +<span id="85">85</span> +<span id="86">86</span> +<span id="87">87</span> +<span id="88">88</span> +<span id="89">89</span> +<span id="90">90</span> +<span id="91">91</span> +<span id="92">92</span> +<span id="93">93</span> +<span id="94">94</span> +<span id="95">95</span> +<span id="96">96</span> +<span id="97">97</span> +<span id="98">98</span> +<span id="99">99</span> +<span id="100">100</span> +<span id="101">101</span> +<span id="102">102</span> +<span id="103">103</span> +<span id="104">104</span> +<span id="105">105</span> +<span id="106">106</span> +<span id="107">107</span> +<span id="108">108</span> +<span id="109">109</span> +<span id="110">110</span> +<span id="111">111</span> +<span id="112">112</span> +<span id="113">113</span> +<span id="114">114</span> +<span id="115">115</span> +<span id="116">116</span> +<span id="117">117</span> +<span id="118">118</span> +<span id="119">119</span> +<span id="120">120</span> +<span id="121">121</span> +<span id="122">122</span> +<span id="123">123</span> +<span id="124">124</span> +<span id="125">125</span> +<span id="126">126</span> +<span id="127">127</span> +<span id="128">128</span> +<span id="129">129</span> +<span id="130">130</span> +<span id="131">131</span> +<span id="132">132</span> +<span id="133">133</span> +<span id="134">134</span> +<span id="135">135</span> +<span id="136">136</span> +<span id="137">137</span> +<span id="138">138</span> +<span id="139">139</span> +<span id="140">140</span> +<span id="141">141</span> +<span id="142">142</span> +<span id="143">143</span> +<span id="144">144</span> +<span id="145">145</span> +<span id="146">146</span> +<span id="147">147</span> +<span id="148">148</span> +<span id="149">149</span> +<span id="150">150</span> +<span id="151">151</span> +<span id="152">152</span> +<span id="153">153</span> +<span id="154">154</span> +<span id="155">155</span> +<span id="156">156</span> +<span id="157">157</span> +<span id="158">158</span> +<span id="159">159</span> +<span id="160">160</span> +<span id="161">161</span> +<span id="162">162</span> +<span id="163">163</span> +<span id="164">164</span> +<span id="165">165</span> +<span id="166">166</span> +<span id="167">167</span> +<span id="168">168</span> +<span id="169">169</span> +<span id="170">170</span> +<span id="171">171</span> +<span id="172">172</span> +<span id="173">173</span> +<span id="174">174</span> +<span id="175">175</span> +<span id="176">176</span> +<span id="177">177</span> +<span id="178">178</span> +<span id="179">179</span> +<span id="180">180</span> +<span id="181">181</span> +<span id="182">182</span> +<span id="183">183</span> +<span id="184">184</span> +<span id="185">185</span> +<span id="186">186</span> +<span id="187">187</span> +<span id="188">188</span> +<span id="189">189</span> +<span id="190">190</span> +<span id="191">191</span> +<span id="192">192</span> +<span id="193">193</span> +<span id="194">194</span> +<span id="195">195</span> +<span id="196">196</span> +<span id="197">197</span> +<span id="198">198</span> +<span id="199">199</span> +<span id="200">200</span> +<span id="201">201</span> +<span id="202">202</span> +<span id="203">203</span> +<span id="204">204</span> +<span id="205">205</span> +<span id="206">206</span> +<span id="207">207</span> +<span id="208">208</span> +<span id="209">209</span> +<span id="210">210</span> +<span id="211">211</span> +<span id="212">212</span> +<span id="213">213</span> +<span id="214">214</span> +<span id="215">215</span> +<span id="216">216</span> +<span id="217">217</span> +<span id="218">218</span> +<span id="219">219</span> +<span id="220">220</span> +<span id="221">221</span> +<span id="222">222</span> +<span id="223">223</span> +<span id="224">224</span> +<span id="225">225</span> +<span id="226">226</span> +<span id="227">227</span> +<span id="228">228</span> +<span id="229">229</span> +<span id="230">230</span> +<span id="231">231</span> +<span id="232">232</span> +<span id="233">233</span> +<span id="234">234</span> +<span id="235">235</span> +<span id="236">236</span> +<span id="237">237</span> +<span id="238">238</span> +<span id="239">239</span> +<span id="240">240</span> +<span id="241">241</span> +<span id="242">242</span> +<span id="243">243</span> +<span id="244">244</span> +<span id="245">245</span> +<span id="246">246</span> +<span id="247">247</span> +<span id="248">248</span> +<span id="249">249</span> +<span id="250">250</span> +<span id="251">251</span> +<span id="252">252</span> +<span id="253">253</span> +<span id="254">254</span> +<span id="255">255</span> +<span id="256">256</span> +<span id="257">257</span> +<span id="258">258</span> +<span id="259">259</span> +<span id="260">260</span> +<span id="261">261</span> +<span id="262">262</span> +<span id="263">263</span> +<span id="264">264</span> +<span id="265">265</span> +<span id="266">266</span> +<span id="267">267</span> +<span id="268">268</span> +<span id="269">269</span> +<span id="270">270</span> +<span id="271">271</span> +<span id="272">272</span> +<span id="273">273</span> +<span id="274">274</span> +<span id="275">275</span> +<span id="276">276</span> +<span id="277">277</span> +<span id="278">278</span> +<span id="279">279</span> +<span id="280">280</span> +<span id="281">281</span> +<span id="282">282</span> +<span id="283">283</span> +<span id="284">284</span> +<span id="285">285</span> +<span id="286">286</span> +<span id="287">287</span> +<span id="288">288</span> +<span id="289">289</span> +<span id="290">290</span> +<span id="291">291</span> +</pre><pre class="rust"><code><span class="comment">// Copyright 2019 Developers of the Rand project. +// +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or +// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license +// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +</span><span class="doccomment">//! Interface to the operating system's random number generator. +//! +//! # Supported targets +//! +//! | Target | Target Triple | Implementation +//! | ----------------- | ------------------ | -------------- +//! | Linux, Android | `*‑linux‑*` | [`getrandom`][1] system call if available, otherwise [`/dev/urandom`][2] after successfully polling `/dev/random` +//! | Windows | `*‑windows‑*` | [`BCryptGenRandom`] +//! | macOS | `*‑apple‑darwin` | [`getentropy`][3] if available, otherwise [`/dev/random`][4] (identical to `/dev/urandom`) +//! | iOS | `*‑apple‑ios` | [`SecRandomCopyBytes`] +//! | FreeBSD | `*‑freebsd` | [`getrandom`][5] if available, otherwise [`kern.arandom`][6] +//! | OpenBSD | `*‑openbsd` | [`getentropy`][7] +//! | NetBSD | `*‑netbsd` | [`kern.arandom`][8] +//! | Dragonfly BSD | `*‑dragonfly` | [`getrandom`][9] if available, otherwise [`/dev/random`][10] +//! | Solaris, illumos | `*‑solaris`, `*‑illumos` | [`getrandom`][11] if available, otherwise [`/dev/random`][12] +//! | Fuchsia OS | `*‑fuchsia` | [`cprng_draw`] +//! | Redox | `*‑redox` | `/dev/urandom` +//! | Haiku | `*‑haiku` | `/dev/random` (identical to `/dev/urandom`) +//! | Hermit | `x86_64-*-hermit` | [`RDRAND`] +//! | SGX | `x86_64‑*‑sgx` | [`RDRAND`] +//! | VxWorks | `*‑wrs‑vxworks‑*` | `randABytes` after checking entropy pool initialization with `randSecure` +//! | ESP-IDF | `*‑espidf` | [`esp_fill_random`] +//! | Emscripten | `*‑emscripten` | `/dev/random` (identical to `/dev/urandom`) +//! | WASI | `wasm32‑wasi` | [`random_get`] +//! | Web Browser and Node.js | `wasm32‑*‑unknown` | [`Crypto.getRandomValues`] if available, then [`crypto.randomFillSync`] if on Node.js, see [WebAssembly support] +//! | SOLID | `*-kmc-solid_*` | `SOLID_RNG_SampleRandomBytes` +//! | Nintendo 3DS | `armv6k-nintendo-3ds` | [`getrandom`][1] +//! +//! There is no blanket implementation on `unix` targets that reads from +//! `/dev/urandom`. This ensures all supported targets are using the recommended +//! interface and respect maximum buffer sizes. +//! +//! Pull Requests that add support for new targets to `getrandom` are always welcome. +//! +//! ## Unsupported targets +//! +//! By default, `getrandom` will not compile on unsupported targets, but certain +//! features allow a user to select a "fallback" implementation if no supported +//! implementation exists. +//! +//! All of the below mechanisms only affect unsupported +//! targets. Supported targets will _always_ use their supported implementations. +//! This prevents a crate from overriding a secure source of randomness +//! (either accidentally or intentionally). +//! +//! ### RDRAND on x86 +//! +//! *If the `rdrand` Cargo feature is enabled*, `getrandom` will fallback to using +//! the [`RDRAND`] instruction to get randomness on `no_std` `x86`/`x86_64` +//! targets. This feature has no effect on other CPU architectures. +//! +//! ### WebAssembly support +//! +//! This crate fully supports the +//! [`wasm32-wasi`](https://github.com/CraneStation/wasi) and +//! [`wasm32-unknown-emscripten`](https://www.hellorust.com/setup/emscripten/) +//! targets. However, the `wasm32-unknown-unknown` target (i.e. the target used +//! by `wasm-pack`) is not automatically +//! supported since, from the target name alone, we cannot deduce which +//! JavaScript interface is in use (or if JavaScript is available at all). +//! +//! Instead, *if the `js` Cargo feature is enabled*, this crate will assume +//! that you are building for an environment containing JavaScript, and will +//! call the appropriate methods. Both web browser (main window and Web Workers) +//! and Node.js environments are supported, invoking the methods +//! [described above](#supported-targets) using the [`wasm-bindgen`] toolchain. +//! +//! To enable the `js` Cargo feature, add the following to the `dependencies` +//! section in your `Cargo.toml` file: +//! ```toml +//! [dependencies] +//! getrandom = { version = "0.2", features = ["js"] } +//! ``` +//! +//! This can be done even if `getrandom` is not a direct dependency. Cargo +//! allows crates to enable features for indirect dependencies. +//! +//! This feature should only be enabled for binary, test, or benchmark crates. +//! Library crates should generally not enable this feature, leaving such a +//! decision to *users* of their library. Also, libraries should not introduce +//! their own `js` features *just* to enable `getrandom`'s `js` feature. +//! +//! This feature has no effect on targets other than `wasm32-unknown-unknown`. +//! +//! #### Node.js ES module support +//! +//! Node.js supports both [CommonJS modules] and [ES modules]. Due to +//! limitations in wasm-bindgen's [`module`] support, we cannot directly +//! support ES Modules running on Node.js. However, on Node v15 and later, the +//! module author can add a simple shim to support the Web Cryptography API: +//! ```js +//! import { webcrypto } from 'node:crypto' +//! globalThis.crypto = webcrypto +//! ``` +//! This crate will then use the provided `webcrypto` implementation. +//! +//! ### Custom implementations +//! +//! The [`register_custom_getrandom!`] macro allows a user to mark their own +//! function as the backing implementation for [`getrandom`]. See the macro's +//! documentation for more information about writing and registering your own +//! custom implementations. +//! +//! Note that registering a custom implementation only has an effect on targets +//! that would otherwise not compile. Any supported targets (including those +//! using `rdrand` and `js` Cargo features) continue using their normal +//! implementations even if a function is registered. +//! +//! ## Early boot +//! +//! Sometimes, early in the boot process, the OS has not collected enough +//! entropy to securely seed its RNG. This is especially common on virtual +//! machines, where standard "random" events are hard to come by. +//! +//! Some operating system interfaces always block until the RNG is securely +//! seeded. This can take anywhere from a few seconds to more than a minute. +//! A few (Linux, NetBSD and Solaris) offer a choice between blocking and +//! getting an error; in these cases, we always choose to block. +//! +//! On Linux (when the `getrandom` system call is not available), reading from +//! `/dev/urandom` never blocks, even when the OS hasn't collected enough +//! entropy yet. To avoid returning low-entropy bytes, we first poll +//! `/dev/random` and only switch to `/dev/urandom` once this has succeeded. +//! +//! On OpenBSD, this kind of entropy accounting isn't available, and on +//! NetBSD, blocking on it is discouraged. On these platforms, nonblocking +//! interfaces are used, even when reliable entropy may not be available. +//! On the platforms where it is used, the reliability of entropy accounting +//! itself isn't free from controversy. This library provides randomness +//! sourced according to the platform's best practices, but each platform has +//! its own limits on the grade of randomness it can promise in environments +//! with few sources of entropy. +//! +//! ## Error handling +//! +//! We always choose failure over returning known insecure "random" bytes. In +//! general, on supported platforms, failure is highly unlikely, though not +//! impossible. If an error does occur, then it is likely that it will occur +//! on every call to `getrandom`, hence after the first successful call one +//! can be reasonably confident that no errors will occur. +//! +//! [1]: http://man7.org/linux/man-pages/man2/getrandom.2.html +//! [2]: http://man7.org/linux/man-pages/man4/urandom.4.html +//! [3]: https://www.unix.com/man-page/mojave/2/getentropy/ +//! [4]: https://www.unix.com/man-page/mojave/4/random/ +//! [5]: https://www.freebsd.org/cgi/man.cgi?query=getrandom&manpath=FreeBSD+12.0-stable +//! [6]: https://www.freebsd.org/cgi/man.cgi?query=random&sektion=4 +//! [7]: https://man.openbsd.org/getentropy.2 +//! [8]: https://man.netbsd.org/sysctl.7 +//! [9]: https://leaf.dragonflybsd.org/cgi/web-man?command=getrandom +//! [10]: https://leaf.dragonflybsd.org/cgi/web-man?command=random&section=4 +//! [11]: https://docs.oracle.com/cd/E88353_01/html/E37841/getrandom-2.html +//! [12]: https://docs.oracle.com/cd/E86824_01/html/E54777/random-7d.html +//! +//! [`BCryptGenRandom`]: https://docs.microsoft.com/en-us/windows/win32/api/bcrypt/nf-bcrypt-bcryptgenrandom +//! [`Crypto.getRandomValues`]: https://www.w3.org/TR/WebCryptoAPI/#Crypto-method-getRandomValues +//! [`RDRAND`]: https://software.intel.com/en-us/articles/intel-digital-random-number-generator-drng-software-implementation-guide +//! [`SecRandomCopyBytes`]: https://developer.apple.com/documentation/security/1399291-secrandomcopybytes?language=objc +//! [`cprng_draw`]: https://fuchsia.dev/fuchsia-src/zircon/syscalls/cprng_draw +//! [`crypto.randomFillSync`]: https://nodejs.org/api/crypto.html#cryptorandomfillsyncbuffer-offset-size +//! [`esp_fill_random`]: https://docs.espressif.com/projects/esp-idf/en/latest/esp32/api-reference/system/random.html#_CPPv415esp_fill_randomPv6size_t +//! [`random_get`]: https://github.com/WebAssembly/WASI/blob/main/phases/snapshot/docs.md#-random_getbuf-pointeru8-buf_len-size---errno +//! [WebAssembly support]: #webassembly-support +//! [`wasm-bindgen`]: https://github.com/rustwasm/wasm-bindgen +//! [`module`]: https://rustwasm.github.io/wasm-bindgen/reference/attributes/on-js-imports/module.html +//! [CommonJS modules]: https://nodejs.org/api/modules.html +//! [ES modules]: https://nodejs.org/api/esm.html + +</span><span class="attribute">#![doc( + html_logo_url = <span class="string">"https://www.rust-lang.org/logos/rust-logo-128x128-blk.png"</span>, + html_favicon_url = <span class="string">"https://www.rust-lang.org/favicon.ico"</span>, + html_root_url = <span class="string">"https://docs.rs/getrandom/0.2.8" +</span>)] +#![no_std] +#![warn(rust_2018_idioms, unused_lifetimes, missing_docs)] +#![cfg_attr(docsrs, feature(doc_cfg))] + +#[macro_use] +</span><span class="kw">extern crate </span>cfg_if; + +<span class="kw">mod </span>error; +<span class="kw">mod </span>util; +<span class="comment">// To prevent a breaking change when targets are added, we always export the +// register_custom_getrandom macro, so old Custom RNG crates continue to build. +</span><span class="attribute">#[cfg(feature = <span class="string">"custom"</span>)] +</span><span class="kw">mod </span>custom; +<span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] +</span><span class="kw">mod </span>error_impls; + +<span class="kw">pub use </span><span class="kw">crate</span>::error::Error; + +<span class="comment">// System-specific implementations. +// +// 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">#[cfg(any(target_os = <span class="string">"emscripten"</span>, target_os = <span class="string">"haiku"</span>, + target_os = <span class="string">"redox"</span>))] </span>{ + <span class="kw">mod </span>util_libc; + <span class="attribute">#[path = <span class="string">"use_file.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(any(target_os = <span class="string">"android"</span>, target_os = <span class="string">"linux"</span>))] </span>{ + <span class="kw">mod </span>util_libc; + <span class="kw">mod </span>use_file; + <span class="attribute">#[path = <span class="string">"linux_android.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(any(target_os = <span class="string">"illumos"</span>, target_os = <span class="string">"solaris"</span>))] </span>{ + <span class="kw">mod </span>util_libc; + <span class="kw">mod </span>use_file; + <span class="attribute">#[path = <span class="string">"solaris_illumos.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(any(target_os = <span class="string">"freebsd"</span>, target_os = <span class="string">"netbsd"</span>))] </span>{ + <span class="kw">mod </span>util_libc; + <span class="attribute">#[path = <span class="string">"bsd_arandom.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"dragonfly"</span>)] </span>{ + <span class="kw">mod </span>util_libc; + <span class="kw">mod </span>use_file; + <span class="attribute">#[path = <span class="string">"dragonfly.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"fuchsia"</span>)] </span>{ + <span class="attribute">#[path = <span class="string">"fuchsia.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"ios"</span>)] </span>{ + <span class="attribute">#[path = <span class="string">"ios.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"macos"</span>)] </span>{ + <span class="kw">mod </span>util_libc; + <span class="kw">mod </span>use_file; + <span class="attribute">#[path = <span class="string">"macos.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"openbsd"</span>)] </span>{ + <span class="kw">mod </span>util_libc; + <span class="attribute">#[path = <span class="string">"openbsd.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"wasi"</span>)] </span>{ + <span class="attribute">#[path = <span class="string">"wasi.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(all(target_arch = <span class="string">"x86_64"</span>, target_os = <span class="string">"hermit"</span>))] </span>{ + <span class="attribute">#[path = <span class="string">"rdrand.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"vxworks"</span>)] </span>{ + <span class="kw">mod </span>util_libc; + <span class="attribute">#[path = <span class="string">"vxworks.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"solid_asp3"</span>)] </span>{ + <span class="attribute">#[path = <span class="string">"solid.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"espidf"</span>)] </span>{ + <span class="attribute">#[path = <span class="string">"espidf.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(windows)] </span>{ + <span class="attribute">#[path = <span class="string">"windows.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(all(target_arch = <span class="string">"x86_64"</span>, target_env = <span class="string">"sgx"</span>))] </span>{ + <span class="attribute">#[path = <span class="string">"rdrand.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(all(feature = <span class="string">"rdrand"</span>, + any(target_arch = <span class="string">"x86_64"</span>, target_arch = <span class="string">"x86"</span>)))] </span>{ + <span class="attribute">#[path = <span class="string">"rdrand.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(all(feature = <span class="string">"js"</span>, + target_arch = <span class="string">"wasm32"</span>, target_os = <span class="string">"unknown"</span>))] </span>{ + <span class="attribute">#[path = <span class="string">"js.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(all(target_os = <span class="string">"horizon"</span>, target_arch = <span class="string">"arm"</span>))] </span>{ + <span class="comment">// We check for target_arch = "arm" because the Nintendo Switch also + // uses Horizon OS (it is aarch64). + </span><span class="kw">mod </span>util_libc; + <span class="attribute">#[path = <span class="string">"3ds.rs"</span>] </span><span class="kw">mod </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(feature = <span class="string">"custom"</span>)] </span>{ + <span class="kw">use </span>custom <span class="kw">as </span>imp; + } <span class="kw">else if </span><span class="attribute">#[cfg(all(target_arch = <span class="string">"wasm32"</span>, target_os = <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 +/// source. +/// +/// This function returns an error on any failure, including partial reads. We +/// make no guarantees regarding the contents of `dest` on error. If `dest` is +/// empty, `getrandom` immediately returns success, making no calls to the +/// underlying operating system. +/// +/// Blocking is possible, at least during early boot; see module documentation. +/// +/// In general, `getrandom` will be fast enough for interactive usage, though +/// significantly slower than a user-space CSPRNG; for the latter consider +/// [`rand::thread_rng`](https://docs.rs/rand/*/rand/fn.thread_rng.html). +</span><span class="kw">pub fn </span>getrandom(dest: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Result</span><(), Error> { + <span class="kw">if </span>dest.is_empty() { + <span class="kw">return </span><span class="prelude-val">Ok</span>(()); + } + imp::getrandom_inner(dest) +} +</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.66.0 (69f9c33d7 2022-12-12) (Arch Linux rust 1:1.66.0-1)" ></div></body></html>
\ No newline at end of file diff --git a/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/linux_android.rs.html b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/linux_android.rs.html new file mode 100644 index 0000000..19232f1 --- /dev/null +++ b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/linux_android.rs.html @@ -0,0 +1,97 @@ +<!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/pico/.local/share/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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="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="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><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><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> +<span id="2">2</span> +<span id="3">3</span> +<span id="4">4</span> +<span id="5">5</span> +<span id="6">6</span> +<span id="7">7</span> +<span id="8">8</span> +<span id="9">9</span> +<span id="10">10</span> +<span id="11">11</span> +<span id="12">12</span> +<span id="13">13</span> +<span id="14">14</span> +<span id="15">15</span> +<span id="16">16</span> +<span id="17">17</span> +<span id="18">18</span> +<span id="19">19</span> +<span id="20">20</span> +<span id="21">21</span> +<span id="22">22</span> +<span id="23">23</span> +<span id="24">24</span> +<span id="25">25</span> +<span id="26">26</span> +<span id="27">27</span> +<span id="28">28</span> +<span id="29">29</span> +<span id="30">30</span> +<span id="31">31</span> +<span id="32">32</span> +<span id="33">33</span> +<span id="34">34</span> +<span id="35">35</span> +<span id="36">36</span> +<span id="37">37</span> +<span id="38">38</span> +<span id="39">39</span> +<span id="40">40</span> +<span id="41">41</span> +<span id="42">42</span> +<span id="43">43</span> +<span id="44">44</span> +<span id="45">45</span> +<span id="46">46</span> +<span id="47">47</span> +</pre><pre class="rust"><code><span class="comment">// Copyright 2018 Developers of the Rand project. +// +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or +// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license +// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +</span><span class="doccomment">//! Implementation for Linux / Android +</span><span class="kw">use crate</span>::{ + util::LazyBool, + util_libc::{last_os_error, sys_fill_exact}, + {use_file, Error}, +}; + +<span class="kw">pub fn </span>getrandom_inner(dest: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Result</span><(), Error> { + <span class="comment">// getrandom(2) was introduced in Linux 3.17 + </span><span class="kw">static </span>HAS_GETRANDOM: LazyBool = LazyBool::new(); + <span class="kw">if </span>HAS_GETRANDOM.unsync_init(is_getrandom_available) { + sys_fill_exact(dest, |buf| <span class="kw">unsafe </span>{ + getrandom(buf.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span>libc::c_void, buf.len(), <span class="number">0</span>) + }) + } <span class="kw">else </span>{ + use_file::getrandom_inner(dest) + } +} + +<span class="kw">fn </span>is_getrandom_available() -> bool { + <span class="kw">let </span>res = <span class="kw">unsafe </span>{ getrandom(core::ptr::null_mut(), <span class="number">0</span>, libc::GRND_NONBLOCK) }; + <span class="kw">if </span>res < <span class="number">0 </span>{ + <span class="kw">match </span>last_os_error().raw_os_error() { + <span class="prelude-val">Some</span>(libc::ENOSYS) => <span class="bool-val">false</span>, <span class="comment">// No kernel support + </span><span class="prelude-val">Some</span>(libc::EPERM) => <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 fn </span>getrandom( + buf: <span class="kw-2">*mut </span>libc::c_void, + buflen: libc::size_t, + flags: libc::c_uint, +) -> libc::ssize_t { + libc::syscall(libc::SYS_getrandom, buf, buflen, flags) <span class="kw">as </span>libc::ssize_t +} +</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.66.0 (69f9c33d7 2022-12-12) (Arch Linux rust 1:1.66.0-1)" ></div></body></html>
\ No newline at end of file diff --git a/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/use_file.rs.html b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/use_file.rs.html new file mode 100644 index 0000000..27a1fa7 --- /dev/null +++ b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/use_file.rs.html @@ -0,0 +1,281 @@ +<!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/pico/.local/share/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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="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="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><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><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> +<span id="2">2</span> +<span id="3">3</span> +<span id="4">4</span> +<span id="5">5</span> +<span id="6">6</span> +<span id="7">7</span> +<span id="8">8</span> +<span id="9">9</span> +<span id="10">10</span> +<span id="11">11</span> +<span id="12">12</span> +<span id="13">13</span> +<span id="14">14</span> +<span id="15">15</span> +<span id="16">16</span> +<span id="17">17</span> +<span id="18">18</span> +<span id="19">19</span> +<span id="20">20</span> +<span id="21">21</span> +<span id="22">22</span> +<span id="23">23</span> +<span id="24">24</span> +<span id="25">25</span> +<span id="26">26</span> +<span id="27">27</span> +<span id="28">28</span> +<span id="29">29</span> +<span id="30">30</span> +<span id="31">31</span> +<span id="32">32</span> +<span id="33">33</span> +<span id="34">34</span> +<span id="35">35</span> +<span id="36">36</span> +<span id="37">37</span> +<span id="38">38</span> +<span id="39">39</span> +<span id="40">40</span> +<span id="41">41</span> +<span id="42">42</span> +<span id="43">43</span> +<span id="44">44</span> +<span id="45">45</span> +<span id="46">46</span> +<span id="47">47</span> +<span id="48">48</span> +<span id="49">49</span> +<span id="50">50</span> +<span id="51">51</span> +<span id="52">52</span> +<span id="53">53</span> +<span id="54">54</span> +<span id="55">55</span> +<span id="56">56</span> +<span id="57">57</span> +<span id="58">58</span> +<span id="59">59</span> +<span id="60">60</span> +<span id="61">61</span> +<span id="62">62</span> +<span id="63">63</span> +<span id="64">64</span> +<span id="65">65</span> +<span id="66">66</span> +<span id="67">67</span> +<span id="68">68</span> +<span id="69">69</span> +<span id="70">70</span> +<span id="71">71</span> +<span id="72">72</span> +<span id="73">73</span> +<span id="74">74</span> +<span id="75">75</span> +<span id="76">76</span> +<span id="77">77</span> +<span id="78">78</span> +<span id="79">79</span> +<span id="80">80</span> +<span id="81">81</span> +<span id="82">82</span> +<span id="83">83</span> +<span id="84">84</span> +<span id="85">85</span> +<span id="86">86</span> +<span id="87">87</span> +<span id="88">88</span> +<span id="89">89</span> +<span id="90">90</span> +<span id="91">91</span> +<span id="92">92</span> +<span id="93">93</span> +<span id="94">94</span> +<span id="95">95</span> +<span id="96">96</span> +<span id="97">97</span> +<span id="98">98</span> +<span id="99">99</span> +<span id="100">100</span> +<span id="101">101</span> +<span id="102">102</span> +<span id="103">103</span> +<span id="104">104</span> +<span id="105">105</span> +<span id="106">106</span> +<span id="107">107</span> +<span id="108">108</span> +<span id="109">109</span> +<span id="110">110</span> +<span id="111">111</span> +<span id="112">112</span> +<span id="113">113</span> +<span id="114">114</span> +<span id="115">115</span> +<span id="116">116</span> +<span id="117">117</span> +<span id="118">118</span> +<span id="119">119</span> +<span id="120">120</span> +<span id="121">121</span> +<span id="122">122</span> +<span id="123">123</span> +<span id="124">124</span> +<span id="125">125</span> +<span id="126">126</span> +<span id="127">127</span> +<span id="128">128</span> +<span id="129">129</span> +<span id="130">130</span> +<span id="131">131</span> +<span id="132">132</span> +<span id="133">133</span> +<span id="134">134</span> +<span id="135">135</span> +<span id="136">136</span> +<span id="137">137</span> +<span id="138">138</span> +<span id="139">139</span> +</pre><pre class="rust"><code><span class="comment">// Copyright 2018 Developers of the Rand project. +// +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or +// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license +// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. + +</span><span class="doccomment">//! Implementations that just need to read from a file +</span><span class="kw">use crate</span>::{ + util::LazyUsize, + util_libc::{open_readonly, sys_fill_exact}, + Error, +}; +<span class="kw">use </span>core::{ + cell::UnsafeCell, + sync::atomic::{AtomicUsize, Ordering::Relaxed}, +}; + +<span class="attribute">#[cfg(any( + target_os = <span class="string">"dragonfly"</span>, + target_os = <span class="string">"emscripten"</span>, + target_os = <span class="string">"haiku"</span>, + target_os = <span class="string">"macos"</span>, + target_os = <span class="string">"solaris"</span>, + target_os = <span class="string">"illumos" +</span>))] +</span><span class="kw">const </span>FILE_PATH: <span class="kw-2">&</span>str = <span class="string">"/dev/random\0"</span>; +<span class="attribute">#[cfg(any(target_os = <span class="string">"android"</span>, target_os = <span class="string">"linux"</span>, target_os = <span class="string">"redox"</span>))] +</span><span class="kw">const </span>FILE_PATH: <span class="kw-2">&</span>str = <span class="string">"/dev/urandom\0"</span>; + +<span class="kw">pub fn </span>getrandom_inner(dest: <span class="kw-2">&mut </span>[u8]) -> <span class="prelude-ty">Result</span><(), Error> { + <span class="kw">let </span>fd = get_rng_fd()<span class="question-mark">?</span>; + <span class="kw">let </span>read = |buf: <span class="kw-2">&mut </span>[u8]| <span class="kw">unsafe </span>{ libc::read(fd, buf.as_mut_ptr() <span class="kw">as </span><span class="kw-2">*mut </span><span class="kw">_</span>, buf.len()) }; + + <span class="kw">if </span><span class="macro">cfg!</span>(target_os = <span class="string">"emscripten"</span>) { + <span class="comment">// `Crypto.getRandomValues` documents `dest` should be at most 65536 bytes. + </span><span class="kw">for </span>chunk <span class="kw">in </span>dest.chunks_mut(<span class="number">65536</span>) { + sys_fill_exact(chunk, read)<span class="question-mark">?</span>; + } + } <span class="kw">else </span>{ + sys_fill_exact(dest, read)<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 +// bytes. The file will be opened exactly once. All subsequent calls will +// return the same file descriptor. This file descriptor is never closed. +</span><span class="kw">fn </span>get_rng_fd() -> <span class="prelude-ty">Result</span><libc::c_int, Error> { + <span class="kw">static </span>FD: AtomicUsize = AtomicUsize::new(LazyUsize::UNINIT); + <span class="kw">fn </span>get_fd() -> <span class="prelude-ty">Option</span><libc::c_int> { + <span class="kw">match </span>FD.load(Relaxed) { + LazyUsize::UNINIT => <span class="prelude-val">None</span>, + val => <span class="prelude-val">Some</span>(val <span class="kw">as </span>libc::c_int), + } + } + + <span class="comment">// Use double-checked locking to avoid acquiring the lock if possible. + </span><span class="kw">if let </span><span class="prelude-val">Some</span>(fd) = get_fd() { + <span class="kw">return </span><span class="prelude-val">Ok</span>(fd); + } + + <span class="comment">// SAFETY: We use the mutex only in this method, and we always unlock it + // before returning, making sure we don't violate the pthread_mutex_t API. + </span><span class="kw">static </span>MUTEX: Mutex = Mutex::new(); + <span class="kw">unsafe </span>{ MUTEX.lock() }; + <span class="kw">let </span>_guard = DropGuard(|| <span class="kw">unsafe </span>{ MUTEX.unlock() }); + + <span class="kw">if let </span><span class="prelude-val">Some</span>(fd) = get_fd() { + <span class="kw">return </span><span class="prelude-val">Ok</span>(fd); + } + + <span class="comment">// On Linux, /dev/urandom might return insecure values. + </span><span class="attribute">#[cfg(any(target_os = <span class="string">"android"</span>, target_os = <span class="string">"linux"</span>))] + </span>wait_until_rng_ready()<span class="question-mark">?</span>; + + <span class="kw">let </span>fd = <span class="kw">unsafe </span>{ open_readonly(FILE_PATH)<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>(fd >= <span class="number">0 </span>&& (fd <span class="kw">as </span>usize) < LazyUsize::UNINIT); + FD.store(fd <span class="kw">as </span>usize, Relaxed); + + <span class="prelude-val">Ok</span>(fd) +} + +<span class="comment">// Succeeds once /dev/urandom is safe to read from +</span><span class="attribute">#[cfg(any(target_os = <span class="string">"android"</span>, target_os = <span class="string">"linux"</span>))] +</span><span class="kw">fn </span>wait_until_rng_ready() -> <span class="prelude-ty">Result</span><(), Error> { + <span class="comment">// Poll /dev/random to make sure it is ok to read from /dev/urandom. + </span><span class="kw">let </span>fd = <span class="kw">unsafe </span>{ open_readonly(<span class="string">"/dev/random\0"</span>)<span class="question-mark">? </span>}; + <span class="kw">let </span><span class="kw-2">mut </span>pfd = libc::pollfd { + fd, + events: libc::POLLIN, + revents: <span class="number">0</span>, + }; + <span class="kw">let </span>_guard = DropGuard(|| <span class="kw">unsafe </span>{ + libc::close(fd); + }); + + <span class="kw">loop </span>{ + <span class="comment">// A negative timeout means an infinite timeout. + </span><span class="kw">let </span>res = <span class="kw">unsafe </span>{ libc::poll(<span class="kw-2">&mut </span>pfd, <span class="number">1</span>, -<span class="number">1</span>) }; + <span class="kw">if </span>res >= <span class="number">0 </span>{ + <span class="macro">debug_assert_eq!</span>(res, <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>err = <span class="kw">crate</span>::util_libc::last_os_error(); + <span class="kw">match </span>err.raw_os_error() { + <span class="prelude-val">Some</span>(libc::EINTR) | <span class="prelude-val">Some</span>(libc::EAGAIN) => <span class="kw">continue</span>, + <span class="kw">_ </span>=> <span class="kw">return </span><span class="prelude-val">Err</span>(err), + } + } +} + +<span class="kw">struct </span>Mutex(UnsafeCell<libc::pthread_mutex_t>); + +<span class="kw">impl </span>Mutex { + <span class="kw">const fn </span>new() -> <span class="self">Self </span>{ + <span class="self">Self</span>(UnsafeCell::new(libc::PTHREAD_MUTEX_INITIALIZER)) + } + <span class="kw">unsafe fn </span>lock(<span class="kw-2">&</span><span class="self">self</span>) { + <span class="kw">let </span>r = libc::pthread_mutex_lock(<span class="self">self</span>.<span class="number">0</span>.get()); + <span class="macro">debug_assert_eq!</span>(r, <span class="number">0</span>); + } + <span class="kw">unsafe fn </span>unlock(<span class="kw-2">&</span><span class="self">self</span>) { + <span class="kw">let </span>r = libc::pthread_mutex_unlock(<span class="self">self</span>.<span class="number">0</span>.get()); + <span class="macro">debug_assert_eq!</span>(r, <span class="number">0</span>); + } +} + +<span class="kw">unsafe impl </span>Sync <span class="kw">for </span>Mutex {} + +<span class="kw">struct </span>DropGuard<F: FnMut()>(F); + +<span class="kw">impl</span><F: FnMut()> Drop <span class="kw">for </span>DropGuard<F> { + <span class="kw">fn </span>drop(<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.66.0 (69f9c33d7 2022-12-12) (Arch Linux rust 1:1.66.0-1)" ></div></body></html>
\ No newline at end of file diff --git a/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/util.rs.html b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/util.rs.html new file mode 100644 index 0000000..73b842f --- /dev/null +++ b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/util.rs.html @@ -0,0 +1,131 @@ +<!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/pico/.local/share/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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="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="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><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><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> +<span id="2">2</span> +<span id="3">3</span> +<span id="4">4</span> +<span id="5">5</span> +<span id="6">6</span> +<span id="7">7</span> +<span id="8">8</span> +<span id="9">9</span> +<span id="10">10</span> +<span id="11">11</span> +<span id="12">12</span> +<span id="13">13</span> +<span id="14">14</span> +<span id="15">15</span> +<span id="16">16</span> +<span id="17">17</span> +<span id="18">18</span> +<span id="19">19</span> +<span id="20">20</span> +<span id="21">21</span> +<span id="22">22</span> +<span id="23">23</span> +<span id="24">24</span> +<span id="25">25</span> +<span id="26">26</span> +<span id="27">27</span> +<span id="28">28</span> +<span id="29">29</span> +<span id="30">30</span> +<span id="31">31</span> +<span id="32">32</span> +<span id="33">33</span> +<span id="34">34</span> +<span id="35">35</span> +<span id="36">36</span> +<span id="37">37</span> +<span id="38">38</span> +<span id="39">39</span> +<span id="40">40</span> +<span id="41">41</span> +<span id="42">42</span> +<span id="43">43</span> +<span id="44">44</span> +<span id="45">45</span> +<span id="46">46</span> +<span id="47">47</span> +<span id="48">48</span> +<span id="49">49</span> +<span id="50">50</span> +<span id="51">51</span> +<span id="52">52</span> +<span id="53">53</span> +<span id="54">54</span> +<span id="55">55</span> +<span id="56">56</span> +<span id="57">57</span> +<span id="58">58</span> +<span id="59">59</span> +<span id="60">60</span> +<span id="61">61</span> +<span id="62">62</span> +<span id="63">63</span> +<span id="64">64</span> +</pre><pre class="rust"><code><span class="comment">// Copyright 2019 Developers of the Rand project. +// +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or +// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license +// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. +</span><span class="attribute">#![allow(dead_code)] +</span><span class="kw">use </span>core::sync::atomic::{AtomicUsize, Ordering::Relaxed}; + +<span class="comment">// This structure represents a lazily initialized static usize value. Useful +// when it is preferable to just rerun initialization instead of locking. +// Both unsync_init and sync_init will invoke an init() function until it +// succeeds, then return the cached value for future calls. +// +// Both methods support init() "failing". If the init() method returns UNINIT, +// that value will be returned as normal, but will not be cached. +// +// Users should only depend on the _value_ returned by init() functions. +// Specifically, for the following init() function: +// fn init() -> usize { +// a(); +// let v = b(); +// c(); +// v +// } +// the effects of c() or writes to shared memory will not necessarily be +// observed and additional synchronization methods with be needed. +</span><span class="kw">pub struct </span>LazyUsize(AtomicUsize); + +<span class="kw">impl </span>LazyUsize { + <span class="kw">pub const fn </span>new() -> <span class="self">Self </span>{ + <span class="self">Self</span>(AtomicUsize::new(<span class="self">Self</span>::UNINIT)) + } + + <span class="comment">// The initialization is not completed. + </span><span class="kw">pub const </span>UNINIT: usize = usize::max_value(); + + <span class="comment">// Runs the init() function at least once, returning the value of some run + // of init(). Multiple callers can run their init() functions in parallel. + // init() should always return the same value, if it succeeds. + </span><span class="kw">pub fn </span>unsync_init(<span class="kw-2">&</span><span class="self">self</span>, init: <span class="kw">impl </span>FnOnce() -> usize) -> usize { + <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>val = <span class="self">self</span>.<span class="number">0</span>.load(Relaxed); + <span class="kw">if </span>val == <span class="self">Self</span>::UNINIT { + val = init(); + <span class="self">self</span>.<span class="number">0</span>.store(val, Relaxed); + } + val + } +} + +<span class="comment">// Identical to LazyUsize except with bool instead of usize. +</span><span class="kw">pub struct </span>LazyBool(LazyUsize); + +<span class="kw">impl </span>LazyBool { + <span class="kw">pub const fn </span>new() -> <span class="self">Self </span>{ + <span class="self">Self</span>(LazyUsize::new()) + } + + <span class="kw">pub fn </span>unsync_init(<span class="kw-2">&</span><span class="self">self</span>, init: <span class="kw">impl </span>FnOnce() -> bool) -> bool { + <span class="self">self</span>.<span class="number">0</span>.unsync_init(|| init() <span class="kw">as </span>usize) != <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.66.0 (69f9c33d7 2022-12-12) (Arch Linux rust 1:1.66.0-1)" ></div></body></html>
\ No newline at end of file diff --git a/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/util_libc.rs.html b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/util_libc.rs.html new file mode 100644 index 0000000..95b9e91 --- /dev/null +++ b/rust/theBook/chapter-2-guessing-game/guessing_game/target/doc/src/getrandom/util_libc.rs.html @@ -0,0 +1,323 @@ +<!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/pico/.local/share/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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="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="sidebar"></nav><main><div class="width-limiter"><nav class="sub"><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><form class="search-form"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> +<span id="2">2</span> +<span id="3">3</span> +<span id="4">4</span> +<span id="5">5</span> +<span id="6">6</span> +<span id="7">7</span> +<span id="8">8</span> +<span id="9">9</span> +<span id="10">10</span> +<span id="11">11</span> +<span id="12">12</span> +<span id="13">13</span> +<span id="14">14</span> +<span id="15">15</span> +<span id="16">16</span> +<span id="17">17</span> +<span id="18">18</span> +<span id="19">19</span> +<span id="20">20</span> +<span id="21">21</span> +<span id="22">22</span> +<span id="23">23</span> +<span id="24">24</span> +<span id="25">25</span> +<span id="26">26</span> +<span id="27">27</span> +<span id="28">28</span> +<span id="29">29</span> +<span id="30">30</span> +<span id="31">31</span> +<span id="32">32</span> +<span id="33">33</span> +<span id="34">34</span> +<span id="35">35</span> +<span id="36">36</span> +<span id="37">37</span> +<span id="38">38</span> +<span id="39">39</span> +<span id="40">40</span> +<span id="41">41</span> +<span id="42">42</span> +<span id="43">43</span> +<span id="44">44</span> +<span id="45">45</span> +<span id="46">46</span> +<span id="47">47</span> +<span id="48">48</span> +<span id="49">49</span> +<span id="50">50</span> +<span id="51">51</span> +<span id="52">52</span> +<span id="53">53</span> +<span id="54">54</span> +<span id="55">55</span> +<span id="56">56</span> +<span id="57">57</span> +<span id="58">58</span> +<span id="59">59</span> +<span id="60">60</span> +<span id="61">61</span> +<span id="62">62</span> +<span id="63">63</span> +<span id="64">64</span> +<span id="65">65</span> +<span id="66">66</span> +<span id="67">67</span> +<span id="68">68</span> +<span id="69">69</span> +<span id="70">70</span> +<span id="71">71</span> +<span id="72">72</span> +<span id="73">73</span> +<span id="74">74</span> +<span id="75">75</span> +<span id="76">76</span> +<span id="77">77</span> +<span id="78">78</span> +<span id="79">79</span> +<span id="80">80</span> +<span id="81">81</span> +<span id="82">82</span> +<span id="83">83</span> +<span id="84">84</span> +<span id="85">85</span> +<span id="86">86</span> +<span id="87">87</span> +<span id="88">88</span> +<span id="89">89</span> +<span id="90">90</span> +<span id="91">91</span> +<span id="92">92</span> +<span id="93">93</span> +<span id="94">94</span> +<span id="95">95</span> +<span id="96">96</span> +<span id="97">97</span> +<span id="98">98</span> +<span id="99">99</span> +<span id="100">100</span> +<span id="101">101</span> +<span id="102">102</span> +<span id="103">103</span> +<span id="104">104</span> +<span id="105">105</span> +<span id="106">106</span> +<span id="107">107</span> +<span id="108">108</span> +<span id="109">109</span> +<span id="110">110</span> +<span id="111">111</span> +<span id="112">112</span> +<span id="113">113</span> +<span id="114">114</span> +<span id="115">115</span> +<span id="116">116</span> +<span id="117">117</span> +<span id="118">118</span> +<span id="119">119</span> +<span id="120">120</span> +<span id="121">121</span> +<span id="122">122</span> +<span id="123">123</span> +<span id="124">124</span> +<span id="125">125</span> +<span id="126">126</span> +<span id="127">127</span> +<span id="128">128</span> +<span id="129">129</span> +<span id="130">130</span> +<span id="131">131</span> +<span id="132">132</span> +<span id="133">133</span> +<span id="134">134</span> +<span id="135">135</span> +<span id="136">136</span> +<span id="137">137</span> +<span id="138">138</span> +<span id="139">139</span> +<span id="140">140</span> +<span id="141">141</span> +<span id="142">142</span> +<span id="143">143</span> +<span id="144">144</span> +<span id="145">145</span> +<span id="146">146</span> +<span id="147">147</span> +<span id="148">148</span> +<span id="149">149</span> +<span id="150">150</span> +<span id="151">151</span> +<span id="152">152</span> +<span id="153">153</span> +<span id="154">154</span> +<span id="155">155</span> +<span id="156">156</span> +<span id="157">157</span> +<span id="158">158</span> +<span id="159">159</span> +<span id="160">160</span> +</pre><pre class="rust"><code><span class="comment">// Copyright 2019 Developers of the Rand project. +// +// Licensed under the Apache License, Version 2.0 <LICENSE-APACHE or +// https://www.apache.org/licenses/LICENSE-2.0> or the MIT license +// <LICENSE-MIT or https://opensource.org/licenses/MIT>, at your +// option. This file may not be copied, modified, or distributed +// except according to those terms. +</span><span class="attribute">#![allow(dead_code)] +</span><span class="kw">use </span><span class="kw">crate</span>::Error; +<span class="kw">use </span>core::{ + num::NonZeroU32, + ptr::NonNull, + sync::atomic::{fence, AtomicPtr, Ordering}, +}; +<span class="kw">use </span>libc::c_void; + +<span class="macro">cfg_if! </span>{ + <span class="kw">if </span><span class="attribute">#[cfg(any(target_os = <span class="string">"netbsd"</span>, target_os = <span class="string">"openbsd"</span>, target_os = <span class="string">"android"</span>))] </span>{ + <span class="kw">use </span>libc::__errno <span class="kw">as </span>errno_location; + } <span class="kw">else if </span><span class="attribute">#[cfg(any(target_os = <span class="string">"linux"</span>, target_os = <span class="string">"emscripten"</span>, target_os = <span class="string">"redox"</span>))] </span>{ + <span class="kw">use </span>libc::__errno_location <span class="kw">as </span>errno_location; + } <span class="kw">else if </span><span class="attribute">#[cfg(any(target_os = <span class="string">"solaris"</span>, target_os = <span class="string">"illumos"</span>))] </span>{ + <span class="kw">use </span>libc::___errno <span class="kw">as </span>errno_location; + } <span class="kw">else if </span><span class="attribute">#[cfg(any(target_os = <span class="string">"macos"</span>, target_os = <span class="string">"freebsd"</span>))] </span>{ + <span class="kw">use </span>libc::__error <span class="kw">as </span>errno_location; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"haiku"</span>)] </span>{ + <span class="kw">use </span>libc::_errnop <span class="kw">as </span>errno_location; + } <span class="kw">else if </span><span class="attribute">#[cfg(all(target_os = <span class="string">"horizon"</span>, target_arch = <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>__errno() -> <span class="kw-2">*mut </span>libc::c_int; + } + <span class="kw">use </span>__errno <span class="kw">as </span>errno_location; + } +} + +<span class="macro">cfg_if! </span>{ + <span class="kw">if </span><span class="attribute">#[cfg(target_os = <span class="string">"vxworks"</span>)] </span>{ + <span class="kw">use </span>libc::errnoGet <span class="kw">as </span>get_errno; + } <span class="kw">else if </span><span class="attribute">#[cfg(target_os = <span class="string">"dragonfly"</span>)] </span>{ + <span class="comment">// Until rust-lang/rust#29594 is stable, we cannot get the errno value + // on DragonFlyBSD. So we just return an out-of-range errno. + </span><span class="kw">unsafe fn </span>get_errno() -> libc::c_int { -<span class="number">1 </span>} + } <span class="kw">else </span>{ + <span class="kw">unsafe fn </span>get_errno() -> libc::c_int { <span class="kw-2">*</span>errno_location() } + } +} + +<span class="kw">pub fn </span>last_os_error() -> Error { + <span class="kw">let </span>errno = <span class="kw">unsafe </span>{ get_errno() }; + <span class="kw">if </span>errno > <span class="number">0 </span>{ + Error::from(NonZeroU32::new(errno <span class="kw">as </span>u32).unwrap()) + } <span class="kw">else </span>{ + Error::ERRNO_NOT_POSITIVE + } +} + +<span class="comment">// Fill a buffer by repeatedly invoking a system call. The `sys_fill` function: +// - should return -1 and set errno on failure +// - should return the number of bytes written on success +</span><span class="kw">pub fn </span>sys_fill_exact( + <span class="kw-2">mut </span>buf: <span class="kw-2">&mut </span>[u8], + sys_fill: <span class="kw">impl </span>Fn(<span class="kw-2">&mut </span>[u8]) -> libc::ssize_t, +) -> <span class="prelude-ty">Result</span><(), Error> { + <span class="kw">while </span>!buf.is_empty() { + <span class="kw">let </span>res = sys_fill(buf); + <span class="kw">if </span>res < <span class="number">0 </span>{ + <span class="kw">let </span>err = last_os_error(); + <span class="comment">// We should try again if the call was interrupted. + </span><span class="kw">if </span>err.raw_os_error() != <span class="prelude-val">Some</span>(libc::EINTR) { + <span class="kw">return </span><span class="prelude-val">Err</span>(err); + } + } <span class="kw">else </span>{ + <span class="comment">// We don't check for EOF (ret = 0) as the data we are reading + // should be an infinite stream of random bytes. + </span>buf = <span class="kw-2">&mut </span>buf[(res <span class="kw">as </span>usize)..]; + } + } + <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. +// Used for supporting newer OS features while still building on older systems. +// Based off of the DlsymWeak struct in libstd: +// https://github.com/rust-lang/rust/blob/1.61.0/library/std/src/sys/unix/weak.rs#L84 +// except that the caller must manually cast self.ptr() to a function pointer. +</span><span class="kw">pub struct </span>Weak { + name: <span class="kw-2">&</span><span class="lifetime">'static </span>str, + addr: AtomicPtr<c_void>, +} + +<span class="kw">impl </span>Weak { + <span class="comment">// A non-null pointer value which indicates we are uninitialized. This + // constant should ideally not be a valid address of a function pointer. + // However, if by chance libc::dlsym does return UNINIT, there will not + // be undefined behavior. libc::dlsym will just be called each time ptr() + // is called. This would be inefficient, but correct. + // TODO: Replace with core::ptr::invalid_mut(1) when that is stable. + </span><span class="kw">const </span>UNINIT: <span class="kw-2">*mut </span>c_void = <span class="number">1 </span><span class="kw">as </span><span class="kw-2">*mut </span>c_void; + + <span class="comment">// Construct a binding to a C function with a given name. This function is + // unsafe because `name` _must_ be null terminated. + </span><span class="kw">pub const unsafe fn </span>new(name: <span class="kw-2">&</span><span class="lifetime">'static </span>str) -> <span class="self">Self </span>{ + <span class="self">Self </span>{ + name, + addr: AtomicPtr::new(<span class="self">Self</span>::UNINIT), + } + } + + <span class="comment">// Return the address of a function if present at runtime. Otherwise, + // return None. Multiple callers can call ptr() concurrently. It will + // always return _some_ value returned by libc::dlsym. However, the + // dlsym function may be called multiple times. + </span><span class="kw">pub fn </span>ptr(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><NonNull<c_void>> { + <span class="comment">// Despite having only a single atomic variable (self.addr), we still + // cannot always use Ordering::Relaxed, as we need to make sure a + // successful call to dlsym() is "ordered before" any data read through + // the returned pointer (which occurs when the function is called). + // Our implementation mirrors that of the one in libstd, meaning that + // the use of non-Relaxed operations is probably unnecessary. + </span><span class="kw">match </span><span class="self">self</span>.addr.load(Ordering::Relaxed) { + <span class="self">Self</span>::UNINIT => { + <span class="kw">let </span>symbol = <span class="self">self</span>.name.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>; + <span class="kw">let </span>addr = <span class="kw">unsafe </span>{ libc::dlsym(libc::RTLD_DEFAULT, symbol) }; + <span class="comment">// Synchronizes with the Acquire fence below + </span><span class="self">self</span>.addr.store(addr, Ordering::Release); + NonNull::new(addr) + } + addr => { + <span class="kw">let </span>func = NonNull::new(addr)<span class="question-mark">?</span>; + fence(Ordering::Acquire); + <span class="prelude-val">Some</span>(func) + } + } + } +} + +<span class="macro">cfg_if! </span>{ + <span class="kw">if </span><span class="attribute">#[cfg(any(target_os = <span class="string">"linux"</span>, target_os = <span class="string">"emscripten"</span>))] </span>{ + <span class="kw">use </span>libc::open64 <span class="kw">as </span>open; + } <span class="kw">else </span>{ + <span class="kw">use </span>libc::open; + } +} + +<span class="comment">// SAFETY: path must be null terminated, FD must be manually closed. +</span><span class="kw">pub unsafe fn </span>open_readonly(path: <span class="kw-2">&</span>str) -> <span class="prelude-ty">Result</span><libc::c_int, Error> { + <span class="macro">debug_assert_eq!</span>(path.as_bytes().last(), <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>fd = open(path.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span><span class="kw">_</span>, libc::O_RDONLY | libc::O_CLOEXEC); + <span class="kw">if </span>fd >= <span class="number">0 </span>{ + <span class="kw">return </span><span class="prelude-val">Ok</span>(fd); + } + <span class="kw">let </span>err = last_os_error(); + <span class="comment">// We should try again if open() was interrupted. + </span><span class="kw">if </span>err.raw_os_error() != <span class="prelude-val">Some</span>(libc::EINTR) { + <span class="kw">return </span><span class="prelude-val">Err</span>(err); + } + } +} +</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.66.0 (69f9c33d7 2022-12-12) (Arch Linux rust 1:1.66.0-1)" ></div></body></html>
\ No newline at end of file |