blob: 068fd63404faa77e7275537b47a0c957f740adf0 [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="Something that can be used to reseed an RNG via `ReseedingRng`."><meta name="keywords" content="rust, rustlang, rust-lang, Reseeder"><title>Reseeder in sgx_rand::reseeding - 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="#">Reseeder</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><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::reseeding</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 href="index.html">reseeding</a>::<wbr><a class="trait" href="#">Reseeder</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/reseeding.rs.html#137-140">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 Reseeder&lt;R&gt; {
fn <a href="#tymethod.reseed" class="fnname">reseed</a>(&amp;mut self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>R);
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Something that can be used to reseed an RNG via <code>ReseedingRng</code>.</p>
<h2 id="example"><a href="#example">Example</a></h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>sgx_rand::{Rng, SeedableRng, StdRng};
<span class="kw">use </span>sgx_rand::reseeding::{Reseeder, ReseedingRng};
<span class="kw">struct </span>TickTockReseeder { tick: bool }
<span class="kw">impl </span>Reseeder&lt;StdRng&gt; <span class="kw">for </span>TickTockReseeder {
<span class="kw">fn </span>reseed(<span class="kw-2">&amp;mut </span><span class="self">self</span>, rng: <span class="kw-2">&amp;mut </span>StdRng) {
<span class="kw">let </span>val = <span class="kw">if </span><span class="self">self</span>.tick {<span class="number">0</span>} <span class="kw">else </span>{<span class="number">1</span>};
rng.reseed(<span class="kw-2">&amp;</span>[val]);
<span class="self">self</span>.tick = !<span class="self">self</span>.tick;
}
}
<span class="kw">fn </span>main() {
<span class="kw">let </span>rsdr = TickTockReseeder { tick: <span class="bool-val">true </span>};
<span class="kw">let </span>inner = StdRng::new().unwrap();
<span class="kw">let </span><span class="kw-2">mut </span>rng = ReseedingRng::new(inner, <span class="number">10</span>, rsdr);
<span class="comment">// this will repeat, because it gets reseeded very regularly.
</span><span class="kw">let </span>s: String = rng.gen_ascii_chars().take(<span class="number">100</span>).collect();
<span class="macro">println!</span>(<span class="string">&quot;{}&quot;</span>, s);
}
</code></pre></div>
</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/reseeding.rs.html#139">source</a><h4 class="code-header">fn <a href="#tymethod.reseed" class="fnname">reseed</a>(&amp;mut self, rng: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;mut </a>R)</h4></section></summary><div class="docblock"><p>Reseed the given RNG.</p>
</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-Reseeder%3CR%3E-for-ReseedWithDefault" class="impl has-srclink"><a class="srclink rightside" href="../../src/sgx_rand/reseeding.rs.html#147-151">source</a><a href="#impl-Reseeder%3CR%3E-for-ReseedWithDefault" class="anchor"></a><h3 class="code-header">impl&lt;R:&nbsp;<a class="trait" href="../trait.Rng.html" title="trait sgx_rand::Rng">Rng</a> + <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.Reseeder.html" title="trait sgx_rand::reseeding::Reseeder">Reseeder</a>&lt;R&gt; for <a class="struct" href="struct.ReseedWithDefault.html" title="struct sgx_rand::reseeding::ReseedWithDefault">ReseedWithDefault</a></h3></section></div><script src="../../implementors/sgx_rand/reseeding/trait.Reseeder.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>