| <!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="Source of the Rust file `/root/.cargo/registry/src/github.com-1ecc6299db9ec823/getrandom-0.2.9/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"><a class="sidebar-logo" href="../../getrandom/index.html"><div class="logo-container"> |
| <img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></div></a></nav><main><div class="width-limiter"><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"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span> |
| <span id="2">2</span> |
| <span id="3">3</span> |
| <span id="4">4</span> |
| <span id="5">5</span> |
| <span id="6">6</span> |
| <span id="7">7</span> |
| <span id="8">8</span> |
| <span id="9">9</span> |
| <span id="10">10</span> |
| <span id="11">11</span> |
| <span id="12">12</span> |
| <span id="13">13</span> |
| <span id="14">14</span> |
| <span id="15">15</span> |
| <span id="16">16</span> |
| <span id="17">17</span> |
| <span id="18">18</span> |
| <span id="19">19</span> |
| <span id="20">20</span> |
| <span id="21">21</span> |
| <span id="22">22</span> |
| <span id="23">23</span> |
| <span id="24">24</span> |
| <span id="25">25</span> |
| <span id="26">26</span> |
| <span id="27">27</span> |
| <span id="28">28</span> |
| <span id="29">29</span> |
| <span id="30">30</span> |
| <span id="31">31</span> |
| <span id="32">32</span> |
| <span id="33">33</span> |
| <span id="34">34</span> |
| <span id="35">35</span> |
| <span id="36">36</span> |
| <span id="37">37</span> |
| <span id="38">38</span> |
| <span id="39">39</span> |
| <span id="40">40</span> |
| <span id="41">41</span> |
| <span id="42">42</span> |
| <span id="43">43</span> |
| <span id="44">44</span> |
| <span id="45">45</span> |
| <span id="46">46</span> |
| <span id="47">47</span> |
| <span id="48">48</span> |
| <span id="49">49</span> |
| <span id="50">50</span> |
| <span id="51">51</span> |
| <span id="52">52</span> |
| <span id="53">53</span> |
| <span id="54">54</span> |
| <span id="55">55</span> |
| <span id="56">56</span> |
| <span id="57">57</span> |
| <span id="58">58</span> |
| <span id="59">59</span> |
| <span id="60">60</span> |
| <span id="61">61</span> |
| <span id="62">62</span> |
| <span id="63">63</span> |
| <span id="64">64</span> |
| <span id="65">65</span> |
| <span id="66">66</span> |
| <span id="67">67</span> |
| <span id="68">68</span> |
| <span id="69">69</span> |
| <span id="70">70</span> |
| <span id="71">71</span> |
| <span id="72">72</span> |
| <span id="73">73</span> |
| <span id="74">74</span> |
| <span id="75">75</span> |
| <span id="76">76</span> |
| <span id="77">77</span> |
| <span id="78">78</span> |
| <span id="79">79</span> |
| <span id="80">80</span> |
| <span id="81">81</span> |
| <span id="82">82</span> |
| <span id="83">83</span> |
| <span id="84">84</span> |
| <span id="85">85</span> |
| <span id="86">86</span> |
| <span id="87">87</span> |
| <span id="88">88</span> |
| <span id="89">89</span> |
| <span id="90">90</span> |
| <span id="91">91</span> |
| <span id="92">92</span> |
| <span id="93">93</span> |
| <span id="94">94</span> |
| <span id="95">95</span> |
| <span id="96">96</span> |
| <span id="97">97</span> |
| <span id="98">98</span> |
| <span id="99">99</span> |
| <span id="100">100</span> |
| <span id="101">101</span> |
| <span id="102">102</span> |
| <span id="103">103</span> |
| <span id="104">104</span> |
| <span id="105">105</span> |
| <span id="106">106</span> |
| <span id="107">107</span> |
| <span id="108">108</span> |
| <span id="109">109</span> |
| <span id="110">110</span> |
| <span id="111">111</span> |
| <span id="112">112</span> |
| <span id="113">113</span> |
| <span id="114">114</span> |
| <span id="115">115</span> |
| <span id="116">116</span> |
| <span id="117">117</span> |
| <span id="118">118</span> |
| <span id="119">119</span> |
| <span id="120">120</span> |
| <span id="121">121</span> |
| <span id="122">122</span> |
| <span id="123">123</span> |
| <span id="124">124</span> |
| <span id="125">125</span> |
| <span id="126">126</span> |
| <span id="127">127</span> |
| <span id="128">128</span> |
| <span id="129">129</span> |
| <span id="130">130</span> |
| <span id="131">131</span> |
| <span id="132">132</span> |
| <span id="133">133</span> |
| <span id="134">134</span> |
| <span id="135">135</span> |
| <span id="136">136</span> |
| <span id="137">137</span> |
| <span id="138">138</span> |
| <span id="139">139</span> |
| <span id="140">140</span> |
| <span id="141">141</span> |
| <span id="142">142</span> |
| <span id="143">143</span> |
| <span id="144">144</span> |
| <span id="145">145</span> |
| <span id="146">146</span> |
| <span id="147">147</span> |
| <span id="148">148</span> |
| <span id="149">149</span> |
| <span id="150">150</span> |
| <span id="151">151</span> |
| <span id="152">152</span> |
| <span id="153">153</span> |
| <span id="154">154</span> |
| <span id="155">155</span> |
| <span id="156">156</span> |
| <span id="157">157</span> |
| <span id="158">158</span> |
| <span id="159">159</span> |
| <span id="160">160</span> |
| <span id="161">161</span> |
| <span id="162">162</span> |
| <span id="163">163</span> |
| <span id="164">164</span> |
| <span id="165">165</span> |
| <span id="166">166</span> |
| <span id="167">167</span> |
| <span id="168">168</span> |
| <span id="169">169</span> |
| <span id="170">170</span> |
| <span id="171">171</span> |
| <span id="172">172</span> |
| <span id="173">173</span> |
| <span id="174">174</span> |
| <span id="175">175</span> |
| <span id="176">176</span> |
| <span id="177">177</span> |
| <span id="178">178</span> |
| <span id="179">179</span> |
| <span id="180">180</span> |
| <span id="181">181</span> |
| <span id="182">182</span> |
| <span id="183">183</span> |
| <span id="184">184</span> |
| <span id="185">185</span> |
| <span id="186">186</span> |
| <span id="187">187</span> |
| <span id="188">188</span> |
| <span id="189">189</span> |
| <span id="190">190</span> |
| <span id="191">191</span> |
| </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-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
