trait.Reseeder.html 9.1 KB

123456789101112131415161718192021222324252627282930313233343536373839404142
  1. <!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="API documentation for the Rust `Reseeder` trait in crate `rand`."><meta name="keywords" content="rust, rustlang, rust-lang, Reseeder"><title>rand::reseeding::Reseeder - Rust</title><link rel="stylesheet" type="text/css" href="../../normalize.css"><link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../../dark.css"><link rel="stylesheet" type="text/css" href="../../light.css" id="themeStyle"><script src="../../storage.js"></script><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc trait"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">&#9776;</div><a href='../../rand/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo' width='100'></a><p class='location'>Trait Reseeder</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.reseed">reseed</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>rand</a>::<wbr><a href='index.html'>reseeding</a></p><script>window.sidebarCurrent = {name: 'Reseeder', ty: 'trait', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../../settings.html"><img src="../../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Trait <a href='../index.html'>rand</a>::<wbr><a href='index.html'>reseeding</a>::<wbr><a class="trait" href=''>Reseeder</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>&#x2212;</span>]</a></span><a class='srclink' href='../../src/rand/reseeding.rs.html#129-132' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust trait'>pub trait Reseeder&lt;R&gt; {
  2. 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);
  3. }</pre></div><div class='docblock'><p>Something that can be used to reseed an RNG via <code>ReseedingRng</code>.</p>
  4. <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
  5. <pre class="rust rust-example-rendered">
  6. <span class="kw">use</span> <span class="ident">rand</span>::{<span class="ident">Rng</span>, <span class="ident">SeedableRng</span>, <span class="ident">StdRng</span>};
  7. <span class="kw">use</span> <span class="ident">rand</span>::<span class="ident">reseeding</span>::{<span class="ident">Reseeder</span>, <span class="ident">ReseedingRng</span>};
  8. <span class="kw">struct</span> <span class="ident">TickTockReseeder</span> { <span class="ident">tick</span>: <span class="ident">bool</span> }
  9. <span class="kw">impl</span> <span class="ident">Reseeder</span><span class="op">&lt;</span><span class="ident">StdRng</span><span class="op">&gt;</span> <span class="kw">for</span> <span class="ident">TickTockReseeder</span> {
  10. <span class="kw">fn</span> <span class="ident">reseed</span>(<span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="self">self</span>, <span class="ident">rng</span>: <span class="kw-2">&amp;</span><span class="kw-2">mut</span> <span class="ident">StdRng</span>) {
  11. <span class="kw">let</span> <span class="ident">val</span> <span class="op">=</span> <span class="kw">if</span> <span class="self">self</span>.<span class="ident">tick</span> {<span class="number">0</span>} <span class="kw">else</span> {<span class="number">1</span>};
  12. <span class="ident">rng</span>.<span class="ident">reseed</span>(<span class="kw-2">&amp;</span>[<span class="ident">val</span>]);
  13. <span class="self">self</span>.<span class="ident">tick</span> <span class="op">=</span> <span class="op">!</span><span class="self">self</span>.<span class="ident">tick</span>;
  14. }
  15. }
  16. <span class="kw">fn</span> <span class="ident">main</span>() {
  17. <span class="kw">let</span> <span class="ident">rsdr</span> <span class="op">=</span> <span class="ident">TickTockReseeder</span> { <span class="ident">tick</span>: <span class="bool-val">true</span> };
  18. <span class="kw">let</span> <span class="ident">inner</span> <span class="op">=</span> <span class="ident">StdRng</span>::<span class="ident">new</span>().<span class="ident">unwrap</span>();
  19. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rng</span> <span class="op">=</span> <span class="ident">ReseedingRng</span>::<span class="ident">new</span>(<span class="ident">inner</span>, <span class="number">10</span>, <span class="ident">rsdr</span>);
  20. <span class="comment">// this will repeat, because it gets reseeded very regularly.</span>
  21. <span class="kw">let</span> <span class="ident">s</span>: <span class="ident">String</span> <span class="op">=</span> <span class="ident">rng</span>.<span class="ident">gen_ascii_chars</span>().<span class="ident">take</span>(<span class="number">100</span>).<span class="ident">collect</span>();
  22. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{}&quot;</span>, <span class="ident">s</span>);
  23. }
  24. </pre>
  25. </div>
  26. <h2 id='required-methods' class='small-section-header'>
  27. Required Methods<a href='#required-methods' class='anchor'></a>
  28. </h2>
  29. <div class='methods'>
  30. <h3 id='tymethod.reseed' class='method'><span id='reseed.v' class='invisible'><code>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></span></h3><div class='docblock'><p>Reseed the given RNG.</p>
  31. </div></div>
  32. <h2 id='implementors' class='small-section-header'>
  33. Implementors<a href='#implementors' class='anchor'></a>
  34. </h2>
  35. <ul class='item-list' id='implementors-list'>
  36. <li><table class='table-display'><tbody><tr><td><code>impl&lt;R:&nbsp;<a class="trait" href="../../rand/trait.Rng.html" title="trait 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; Reseeder&lt;R&gt; for <a class="struct" href="../../rand/reseeding/struct.ReseedWithDefault.html" title="struct rand::reseeding::ReseedWithDefault">ReseedWithDefault</a></code><td><div class='out-of-band'><a class='srclink' href='../../src/rand/reseeding.rs.html#139-143' title='goto source code'>[src]</a></div></td></tr></tbody></table></li>
  37. </ul><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
  38. src="../../implementors/rand/reseeding/trait.Reseeder.js">
  39. </script></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>&#9166;</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../../";window.currentCrate = "rand";</script><script src="../../aliases.js"></script><script src="../../main.js"></script><script defer src="../../search-index.js"></script></body></html>