blob: 990cdebb6d8ec64628e1460c0ce00207fd91f69e [file] [log] [blame]
<!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 random number generator that can be explicitly seeded to produce the same stream of randomness multiple times."><meta name="keywords" content="rust, rustlang, rust-lang, SeedableRng"><title>SeedableRng in sgx_rand - Rust</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="sidebar-items.js"></script><script defer src="../main.js"></script><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../favicon.svg"></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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">&#9776;</button><a class="sidebar-logo" href="../sgx_rand/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../sgx_rand/index.html"><div class="logo-container"><img class="rust-logo" src="../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">SeedableRng</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.from_seed">from_seed</a></li><li><a href="#tymethod.reseed">reseed</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In sgx_rand</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><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="main-heading"><h1 class="fqn">Trait <a href="index.html">sgx_rand</a>::<wbr><a class="trait" href="#">SeedableRng</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../src/sgx_rand/lib.rs.html#508-536">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait SeedableRng&lt;Seed&gt;: <a class="trait" href="trait.Rng.html" title="trait sgx_rand::Rng">Rng</a> {
fn <a href="#tymethod.reseed" class="fnname">reseed</a>(&amp;mut self, seed: Seed);
<span class="item-spacer"></span> fn <a href="#tymethod.from_seed" class="fnname">from_seed</a>(seed: Seed) -&gt; Self;
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A random number generator that can be explicitly seeded to produce
the same stream of randomness multiple times.</p>
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.reseed" class="method has-srclink"><a class="srclink rightside" href="../src/sgx_rand/lib.rs.html#522">source</a><h4 class="code-header">fn <a href="#tymethod.reseed" class="fnname">reseed</a>(&amp;mut self, seed: Seed)</h4></section></summary><div class="docblock"><p>Reseed an RNG with the given seed.</p>
<h5 id="example"><a href="#example">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>sgx_rand::{Rng, SeedableRng, StdRng};
<span class="kw">let </span>seed: <span class="kw-2">&amp;</span>[<span class="kw">_</span>] = <span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>];
<span class="kw">let </span><span class="kw-2">mut </span>rng: StdRng = SeedableRng::from_seed(seed);
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, rng.gen::&lt;f64&gt;());
rng.reseed(<span class="kw-2">&amp;</span>[<span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>]);
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, rng.gen::&lt;f64&gt;());</code></pre></div>
</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.from_seed" class="method has-srclink"><a class="srclink rightside" href="../src/sgx_rand/lib.rs.html#535">source</a><h4 class="code-header">fn <a href="#tymethod.from_seed" class="fnname">from_seed</a>(seed: Seed) -&gt; Self</h4></section></summary><div class="docblock"><p>Create a new RNG with the given seed.</p>
<h5 id="example-1"><a href="#example-1">Example</a></h5>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>sgx_rand::{Rng, SeedableRng, StdRng};
<span class="kw">let </span>seed: <span class="kw-2">&amp;</span>[<span class="kw">_</span>] = <span class="kw-2">&amp;</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>];
<span class="kw">let </span><span class="kw-2">mut </span>rng: StdRng = SeedableRng::from_seed(seed);
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, rng.gen::&lt;f64&gt;());</code></pre></div>
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-SeedableRng%3C%5Bu32%3B%204%5D%3E-for-XorShiftRng" class="impl has-srclink"><a class="srclink rightside" href="../src/sgx_rand/lib.rs.html#588-616">source</a><a href="#impl-SeedableRng%3C%5Bu32%3B%204%5D%3E-for-XorShiftRng" class="anchor"></a><h3 class="code-header">impl <a class="trait" href="trait.SeedableRng.html" title="trait sgx_rand::SeedableRng">SeedableRng</a>&lt;[<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.array.html">4</a>]&gt; for <a class="struct" href="struct.XorShiftRng.html" title="struct sgx_rand::XorShiftRng">XorShiftRng</a></h3></section><section id="impl-SeedableRng%3C%26%27a%20%5Bu32%5D%3E-for-ChaChaRng" class="impl has-srclink"><a class="srclink rightside" href="../src/sgx_rand/chacha.rs.html#218-238">source</a><a href="#impl-SeedableRng%3C%26%27a%20%5Bu32%5D%3E-for-ChaChaRng" class="anchor"></a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.SeedableRng.html" title="trait sgx_rand::SeedableRng">SeedableRng</a>&lt;&amp;'a [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>]&gt; for <a class="struct" href="chacha/struct.ChaChaRng.html" title="struct sgx_rand::chacha::ChaChaRng">ChaChaRng</a></h3></section><section id="impl-SeedableRng%3C%26%27a%20%5Bu32%5D%3E-for-IsaacRng" class="impl has-srclink"><a class="srclink rightside" href="../src/sgx_rand/isaac.rs.html#255-282">source</a><a href="#impl-SeedableRng%3C%26%27a%20%5Bu32%5D%3E-for-IsaacRng" class="anchor"></a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.SeedableRng.html" title="trait sgx_rand::SeedableRng">SeedableRng</a>&lt;&amp;'a [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>]&gt; for <a class="struct" href="isaac/struct.IsaacRng.html" title="struct sgx_rand::isaac::IsaacRng">IsaacRng</a></h3></section><section id="impl-SeedableRng%3C%26%27a%20%5Bu64%5D%3E-for-Isaac64Rng" class="impl has-srclink"><a class="srclink rightside" href="../src/sgx_rand/isaac.rs.html#541-568">source</a><a href="#impl-SeedableRng%3C%26%27a%20%5Bu64%5D%3E-for-Isaac64Rng" class="anchor"></a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.SeedableRng.html" title="trait sgx_rand::SeedableRng">SeedableRng</a>&lt;&amp;'a [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a>]&gt; for <a class="struct" href="isaac/struct.Isaac64Rng.html" title="struct sgx_rand::isaac::Isaac64Rng">Isaac64Rng</a></h3></section><section id="impl-SeedableRng%3C%26%27a%20%5Busize%5D%3E-for-StdRng" class="impl has-srclink"><a class="srclink rightside" href="../src/sgx_rand/lib.rs.html#705-718">source</a><a href="#impl-SeedableRng%3C%26%27a%20%5Busize%5D%3E-for-StdRng" class="anchor"></a><h3 class="code-header">impl&lt;'a&gt; <a class="trait" href="trait.SeedableRng.html" title="trait sgx_rand::SeedableRng">SeedableRng</a>&lt;&amp;'a [<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>]&gt; for <a class="struct" href="struct.StdRng.html" title="struct sgx_rand::StdRng">StdRng</a></h3></section><section id="impl-SeedableRng%3C(Rsdr%2C%20S)%3E-for-ReseedingRng%3CR%2C%20Rsdr%3E" class="impl has-srclink"><a class="srclink rightside" href="../src/sgx_rand/reseeding.rs.html#87-106">source</a><a href="#impl-SeedableRng%3C(Rsdr%2C%20S)%3E-for-ReseedingRng%3CR%2C%20Rsdr%3E" class="anchor"></a><h3 class="code-header">impl&lt;S, R:&nbsp;<a class="trait" href="trait.SeedableRng.html" title="trait sgx_rand::SeedableRng">SeedableRng</a>&lt;S&gt;, Rsdr:&nbsp;<a class="trait" href="reseeding/trait.Reseeder.html" title="trait sgx_rand::reseeding::Reseeder">Reseeder</a>&lt;R&gt; + <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a>&gt; <a class="trait" href="trait.SeedableRng.html" title="trait sgx_rand::SeedableRng">SeedableRng</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(Rsdr, S)</a>&gt; for <a class="struct" href="reseeding/struct.ReseedingRng.html" title="struct sgx_rand::reseeding::ReseedingRng">ReseedingRng</a>&lt;R, Rsdr&gt;</h3></section></div><script src="../implementors/sgx_rand/trait.SeedableRng.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="sgx_rand" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>