| <!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/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rand/rand_core/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="../../rand_core/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="../../rand_core/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> |
| <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> |
| </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">//! Error types |
| |
| </span><span class="kw">use </span>core::fmt; |
| <span class="kw">use </span>core::num::NonZeroU32; |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] </span><span class="kw">use </span>std::boxed::Box; |
| |
| <span class="doccomment">/// Error type of random number generators |
| /// |
| /// In order to be compatible with `std` and `no_std`, this type has two |
| /// possible implementations: with `std` a boxed `Error` trait object is stored, |
| /// while with `no_std` we merely store an error code. |
| </span><span class="kw">pub struct </span>Error { |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>inner: Box<<span class="kw">dyn </span>std::error::Error + Send + Sync + <span class="lifetime">'static</span>>, |
| <span class="attribute">#[cfg(not(feature = <span class="string">"std"</span>))] |
| </span>code: NonZeroU32, |
| } |
| |
| <span class="kw">impl </span>Error { |
| <span class="doccomment">/// Codes at or above this point can be used by users to define their own |
| /// custom errors. |
| /// |
| /// This has a fixed value of `(1 << 31) + (1 << 30) = 0xC000_0000`, |
| /// therefore the number of values available for custom codes is `1 << 30`. |
| /// |
| /// This is identical to [`getrandom::Error::CUSTOM_START`](https://docs.rs/getrandom/latest/getrandom/struct.Error.html#associatedconstant.CUSTOM_START). |
| </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">/// 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. |
| /// |
| /// This is identical to [`getrandom::Error::INTERNAL_START`](https://docs.rs/getrandom/latest/getrandom/struct.Error.html#associatedconstant.INTERNAL_START). |
| </span><span class="kw">pub const </span>INTERNAL_START: u32 = <span class="number">1 </span><< <span class="number">31</span>; |
| |
| <span class="doccomment">/// Construct from any type supporting `std::error::Error` |
| /// |
| /// Available only when configured with `std`. |
| /// |
| /// See also `From<NonZeroU32>`, which is available with and without `std`. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| #[cfg_attr(doc_cfg, doc(cfg(feature = <span class="string">"std"</span>)))] |
| #[inline] |
| </span><span class="kw">pub fn </span>new<E>(err: E) -> <span class="self">Self |
| </span><span class="kw">where |
| </span>E: Into<Box<<span class="kw">dyn </span>std::error::Error + Send + Sync + <span class="lifetime">'static</span>>>, |
| { |
| Error { inner: err.into() } |
| } |
| |
| <span class="doccomment">/// Reference the inner error (`std` only) |
| /// |
| /// When configured with `std`, this is a trivial operation and never |
| /// panics. Without `std`, this method is simply unavailable. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| #[cfg_attr(doc_cfg, doc(cfg(feature = <span class="string">"std"</span>)))] |
| #[inline] |
| </span><span class="kw">pub fn </span>inner(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="kw-2">&</span>(<span class="kw">dyn </span>std::error::Error + Send + Sync + <span class="lifetime">'static</span>) { |
| <span class="kw-2">&*</span><span class="self">self</span>.inner |
| } |
| |
| <span class="doccomment">/// Unwrap the inner error (`std` only) |
| /// |
| /// When configured with `std`, this is a trivial operation and never |
| /// panics. Without `std`, this method is simply unavailable. |
| </span><span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| #[cfg_attr(doc_cfg, doc(cfg(feature = <span class="string">"std"</span>)))] |
| #[inline] |
| </span><span class="kw">pub fn </span>take_inner(<span class="self">self</span>) -> Box<<span class="kw">dyn </span>std::error::Error + Send + Sync + <span class="lifetime">'static</span>> { |
| <span class="self">self</span>.inner |
| } |
| |
| <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()`, except |
| /// that it works in `no_std` contexts. If this method returns `None`, the |
| /// error value can still be formatted via the `Display` implementation. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>raw_os_error(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><i32> { |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(e) = <span class="self">self</span>.inner.downcast_ref::<std::io::Error>() { |
| <span class="kw">return </span>e.raw_os_error(); |
| } |
| } |
| <span class="kw">match </span><span class="self">self</span>.code() { |
| <span class="prelude-val">Some</span>(code) <span class="kw">if </span>u32::from(code) < <span class="self">Self</span>::INTERNAL_START => <span class="prelude-val">Some</span>(u32::from(code) <span class="kw">as </span>i32), |
| <span class="kw">_ </span>=> <span class="prelude-val">None</span>, |
| } |
| } |
| |
| <span class="doccomment">/// Retrieve the error code, if any. |
| /// |
| /// If this `Error` was constructed via `From<NonZeroU32>`, then this method |
| /// will return this `NonZeroU32` code (for `no_std` this is always the |
| /// case). Otherwise, this method will return `None`. |
| </span><span class="attribute">#[inline] |
| </span><span class="kw">pub fn </span>code(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><NonZeroU32> { |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>{ |
| <span class="self">self</span>.inner.downcast_ref::<ErrorCode>().map(|c| c.<span class="number">0</span>) |
| } |
| <span class="attribute">#[cfg(not(feature = <span class="string">"std"</span>))] |
| </span>{ |
| <span class="prelude-val">Some</span>(<span class="self">self</span>.code) |
| } |
| } |
| } |
| |
| <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) -> fmt::Result { |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>{ |
| <span class="macro">write!</span>(f, <span class="string">"Error {{ inner: {:?} }}"</span>, <span class="self">self</span>.inner) |
| } |
| <span class="attribute">#[cfg(all(feature = <span class="string">"getrandom"</span>, not(feature = <span class="string">"std"</span>)))] |
| </span>{ |
| getrandom::Error::from(<span class="self">self</span>.code).fmt(f) |
| } |
| <span class="attribute">#[cfg(not(feature = <span class="string">"getrandom"</span>))] |
| </span>{ |
| <span class="macro">write!</span>(f, <span class="string">"Error {{ code: {} }}"</span>, <span class="self">self</span>.code) |
| } |
| } |
| } |
| |
| <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) -> fmt::Result { |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>{ |
| <span class="macro">write!</span>(f, <span class="string">"{}"</span>, <span class="self">self</span>.inner) |
| } |
| <span class="attribute">#[cfg(all(feature = <span class="string">"getrandom"</span>, not(feature = <span class="string">"std"</span>)))] |
| </span>{ |
| getrandom::Error::from(<span class="self">self</span>.code).fmt(f) |
| } |
| <span class="attribute">#[cfg(not(feature = <span class="string">"getrandom"</span>))] |
| </span>{ |
| <span class="macro">write!</span>(f, <span class="string">"error code {}"</span>, <span class="self">self</span>.code) |
| } |
| } |
| } |
| |
| <span class="kw">impl </span>From<NonZeroU32> <span class="kw">for </span>Error { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from(code: NonZeroU32) -> <span class="self">Self </span>{ |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>{ |
| Error { |
| inner: Box::new(ErrorCode(code)), |
| } |
| } |
| <span class="attribute">#[cfg(not(feature = <span class="string">"std"</span>))] |
| </span>{ |
| Error { code } |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"getrandom"</span>)] |
| </span><span class="kw">impl </span>From<getrandom::Error> <span class="kw">for </span>Error { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from(error: getrandom::Error) -> <span class="self">Self </span>{ |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span>{ |
| Error { |
| inner: Box::new(error), |
| } |
| } |
| <span class="attribute">#[cfg(not(feature = <span class="string">"std"</span>))] |
| </span>{ |
| Error { code: error.code() } |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>Error { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>source(<span class="kw-2">&</span><span class="self">self</span>) -> <span class="prelude-ty">Option</span><<span class="kw-2">&</span>(<span class="kw">dyn </span>std::error::Error + <span class="lifetime">'static</span>)> { |
| <span class="self">self</span>.inner.source() |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>From<Error> <span class="kw">for </span>std::io::Error { |
| <span class="attribute">#[inline] |
| </span><span class="kw">fn </span>from(error: Error) -> <span class="self">Self </span>{ |
| <span class="kw">if let </span><span class="prelude-val">Some</span>(code) = error.raw_os_error() { |
| std::io::Error::from_raw_os_error(code) |
| } <span class="kw">else </span>{ |
| std::io::Error::new(std::io::ErrorKind::Other, error) |
| } |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| #[derive(Debug, Copy, Clone)] |
| </span><span class="kw">struct </span>ErrorCode(NonZeroU32); |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>fmt::Display <span class="kw">for </span>ErrorCode { |
| <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) -> fmt::Result { |
| <span class="macro">write!</span>(f, <span class="string">"error code {}"</span>, <span class="self">self</span>.<span class="number">0</span>) |
| } |
| } |
| |
| <span class="attribute">#[cfg(feature = <span class="string">"std"</span>)] |
| </span><span class="kw">impl </span>std::error::Error <span class="kw">for </span>ErrorCode {} |
| |
| <span class="attribute">#[cfg(test)] |
| </span><span class="kw">mod </span>test { |
| <span class="attribute">#[cfg(feature = <span class="string">"getrandom"</span>)] |
| #[test] |
| </span><span class="kw">fn </span>test_error_codes() { |
| <span class="comment">// Make sure the values are the same as in `getrandom`. |
| </span><span class="macro">assert_eq!</span>(<span class="kw">super</span>::Error::CUSTOM_START, getrandom::Error::CUSTOM_START); |
| <span class="macro">assert_eq!</span>(<span class="kw">super</span>::Error::INTERNAL_START, getrandom::Error::INTERNAL_START); |
| } |
| } |
| </code></pre></div> |
| </section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rand_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
