33 lines
17 KiB
HTML
33 lines
17 KiB
HTML
<!DOCTYPE html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width, initial-scale=1.0"><meta name="generator" content="rustdoc"><meta name="description" content="A potentially fallible variant of `RngCore`"><title>TryRngCore in rand_core - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rand_core" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">TryRngCore</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../rand_core/index.html"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><h2><a href="../rand_core/index.html">rand_<wbr>core</a><span class="version">0.9.5</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">TryRng<wbr>Core</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Error" title="Error">Error</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.try_fill_bytes" title="try_fill_bytes">try_fill_bytes</a></li><li><a href="#tymethod.try_next_u32" title="try_next_u32">try_next_u32</a></li><li><a href="#tymethod.try_next_u64" title="try_next_u64">try_next_u64</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.read_adapter" title="read_adapter">read_adapter</a></li><li><a href="#method.unwrap_err" title="unwrap_err">unwrap_err</a></li><li><a href="#method.unwrap_mut" title="unwrap_mut">unwrap_mut</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate rand_<wbr>core</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">rand_core</a></div><h1>Trait <span class="trait">TryRng<wbr>Core</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/rand_core/lib.rs.html#220-252">Source</a> </span></div><pre class="rust item-decl"><code>pub trait TryRngCore {
|
|
type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a>;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.try_next_u32" class="fn">try_next_u32</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>, Self::<a class="associatedtype" href="trait.TryRngCore.html#associatedtype.Error" title="type rand_core::TryRngCore::Error">Error</a>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.try_next_u64" class="fn">try_next_u64</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u64.html">u64</a>, Self::<a class="associatedtype" href="trait.TryRngCore.html#associatedtype.Error" title="type rand_core::TryRngCore::Error">Error</a>>;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.try_fill_bytes" class="fn">try_fill_bytes</a>(&mut self, dst: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.TryRngCore.html#associatedtype.Error" title="type rand_core::TryRngCore::Error">Error</a>>;
|
|
|
|
// Provided methods
|
|
fn <a href="#method.unwrap_err" class="fn">unwrap_err</a>(self) -> <a class="struct" href="struct.UnwrapErr.html" title="struct rand_core::UnwrapErr">UnwrapErr</a><Self>
|
|
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.unwrap_mut" class="fn">unwrap_mut</a>(&mut self) -> <a class="struct" href="struct.UnwrapMut.html" title="struct rand_core::UnwrapMut">UnwrapMut</a><'_, Self> { ... }
|
|
<span class="item-spacer"></span> fn <a href="#method.read_adapter" class="fn">read_adapter</a>(&mut self) -> <a class="struct" href="struct.RngReadAdapter.html" title="struct rand_core::RngReadAdapter">RngReadAdapter</a><'_, Self> <a href="#" class="tooltip" data-notable-ty="RngReadAdapter<'_, Self>">ⓘ</a>
|
|
<span class="where">where Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a></span> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A potentially fallible variant of <a href="trait.RngCore.html" title="trait rand_core::RngCore"><code>RngCore</code></a></p>
|
|
<p>This trait is a generalization of <a href="trait.RngCore.html" title="trait rand_core::RngCore"><code>RngCore</code></a> to support potentially-
|
|
fallible IO-based generators such as <a href="struct.OsRng.html" title="struct rand_core::OsRng"><code>OsRng</code></a>.</p>
|
|
<p>All implementations of <a href="trait.RngCore.html" title="trait rand_core::RngCore"><code>RngCore</code></a> automatically support this <code>TryRngCore</code>
|
|
trait, using <a href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible"><code>Infallible</code></a> as the associated
|
|
<code>Error</code> type.</p>
|
|
<p>An implementation of this trait may be made compatible with code requiring
|
|
an <a href="trait.RngCore.html" title="trait rand_core::RngCore"><code>RngCore</code></a> through <a href="trait.TryRngCore.html#method.unwrap_err" title="method rand_core::TryRngCore::unwrap_err"><code>TryRngCore::unwrap_err</code></a>. The resulting RNG will
|
|
panic in case the underlying fallible RNG yields an error.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Error" class="method"><a class="src rightside" href="../src/rand_core/lib.rs.html#222">Source</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/fmt/trait.Display.html" title="trait core::fmt::Display">Display</a></h4></section></summary><div class="docblock"><p>The type returned in the event of a RNG error.</p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.try_next_u32" class="method"><a class="src rightside" href="../src/rand_core/lib.rs.html#225">Source</a><h4 class="code-header">fn <a href="#tymethod.try_next_u32" class="fn">try_next_u32</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u32.html">u32</a>, Self::<a class="associatedtype" href="trait.TryRngCore.html#associatedtype.Error" title="type rand_core::TryRngCore::Error">Error</a>></h4></section></summary><div class="docblock"><p>Return the next random <code>u32</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.try_next_u64" class="method"><a class="src rightside" href="../src/rand_core/lib.rs.html#227">Source</a><h4 class="code-header">fn <a href="#tymethod.try_next_u64" class="fn">try_next_u64</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u64.html">u64</a>, Self::<a class="associatedtype" href="trait.TryRngCore.html#associatedtype.Error" title="type rand_core::TryRngCore::Error">Error</a>></h4></section></summary><div class="docblock"><p>Return the next random <code>u64</code>.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.try_fill_bytes" class="method"><a class="src rightside" href="../src/rand_core/lib.rs.html#229">Source</a><h4 class="code-header">fn <a href="#tymethod.try_fill_bytes" class="fn">try_fill_bytes</a>(&mut self, dst: &mut [<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.u8.html">u8</a>]) -> <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.unit.html">()</a>, Self::<a class="associatedtype" href="trait.TryRngCore.html#associatedtype.Error" title="type rand_core::TryRngCore::Error">Error</a>></h4></section></summary><div class="docblock"><p>Fill <code>dest</code> entirely with random data.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.unwrap_err" class="method"><a class="src rightside" href="../src/rand_core/lib.rs.html#232-237">Source</a><h4 class="code-header">fn <a href="#method.unwrap_err" class="fn">unwrap_err</a>(self) -> <a class="struct" href="struct.UnwrapErr.html" title="struct rand_core::UnwrapErr">UnwrapErr</a><Self><div class="where">where
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Wrap RNG with the <a href="struct.UnwrapErr.html" title="struct rand_core::UnwrapErr"><code>UnwrapErr</code></a> wrapper.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.unwrap_mut" class="method"><a class="src rightside" href="../src/rand_core/lib.rs.html#240-242">Source</a><h4 class="code-header">fn <a href="#method.unwrap_mut" class="fn">unwrap_mut</a>(&mut self) -> <a class="struct" href="struct.UnwrapMut.html" title="struct rand_core::UnwrapMut">UnwrapMut</a><'_, Self></h4></section></summary><div class="docblock"><p>Wrap RNG with the <a href="struct.UnwrapMut.html" title="struct rand_core::UnwrapMut"><code>UnwrapMut</code></a> wrapper.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="method.read_adapter" class="method"><a class="src rightside" href="../src/rand_core/lib.rs.html#246-251">Source</a><h4 class="code-header">fn <a href="#method.read_adapter" class="fn">read_adapter</a>(&mut self) -> <a class="struct" href="struct.RngReadAdapter.html" title="struct rand_core::RngReadAdapter">RngReadAdapter</a><'_, Self> <a href="#" class="tooltip" data-notable-ty="RngReadAdapter<'_, Self>">ⓘ</a><div class="where">where
|
|
Self: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</div></h4></section></summary><div class="docblock"><p>Convert an <a href="trait.RngCore.html" title="trait rand_core::RngCore"><code>RngCore</code></a> to a <a href="struct.RngReadAdapter.html" title="struct rand_core::RngReadAdapter"><code>RngReadAdapter</code></a>.</p>
|
|
</div></details></div><h2 id="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-TryRngCore-for-OsRng" class="impl"><a class="src rightside" href="../src/rand_core/os.rs.html#83-100">Source</a><a href="#impl-TryRngCore-for-OsRng" class="anchor">§</a><h3 class="code-header">impl <a class="trait" href="trait.TryRngCore.html" title="trait rand_core::TryRngCore">TryRngCore</a> for <a class="struct" href="struct.OsRng.html" title="struct rand_core::OsRng">OsRng</a></h3></section></summary><div class="impl-items"><section id="associatedtype.Error-1" class="associatedtype trait-impl"><a class="src rightside" href="../src/rand_core/os.rs.html#84">Source</a><a href="#associatedtype.Error-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="struct" href="struct.OsError.html" title="struct rand_core::OsError">OsError</a></h4></section></div></details><details class="toggle implementors-toggle"><summary><section id="impl-TryRngCore-for-R" class="impl"><a class="src rightside" href="../src/rand_core/lib.rs.html#257-275">Source</a><a href="#impl-TryRngCore-for-R" class="anchor">§</a><h3 class="code-header">impl<R: <a class="trait" href="trait.RngCore.html" title="trait rand_core::RngCore">RngCore</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.TryRngCore.html" title="trait rand_core::TryRngCore">TryRngCore</a> for R</h3></section></summary><div class="impl-items"><section id="associatedtype.Error-2" class="associatedtype trait-impl"><a class="src rightside" href="../src/rand_core/lib.rs.html#258">Source</a><a href="#associatedtype.Error-2" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/1.93.1/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></div></details></div><script src="../trait.impl/rand_core/trait.TryRngCore.js" async></script><script type="text/json" id="notable-traits-data">{"RngReadAdapter<'_, Self>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.RngReadAdapter.html\" title=\"struct rand_core::RngReadAdapter\">RngReadAdapter</a><'_, R></code></h3><pre><code><div class=\"where\">impl<R: <a class=\"trait\" href=\"trait.TryRngCore.html\" title=\"trait rand_core::TryRngCore\">TryRngCore</a> + ?<a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html\" title=\"trait core::marker::Sized\">Sized</a>> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.93.1/std/io/trait.Read.html\" title=\"trait std::io::Read\">Read</a> for <a class=\"struct\" href=\"struct.RngReadAdapter.html\" title=\"struct rand_core::RngReadAdapter\">RngReadAdapter</a><'_, R></div>"}</script></section></div></main></body></html> |