zcdziura/pumpkin
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
pumpkin/rand/chacha/struct.ChaChaRng.html

162 lines
16 KiB
HTML
Raw Normal View History

Adding documentation for v0.3
2016-05-10 15:03:32 -04:00
<!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 `ChaChaRng` struct in crate `rand`.">
<meta name="keywords" content="rust, rustlang, rust-lang, ChaChaRng">
<title>rand::chacha::ChaChaRng - Rust</title>
<link rel="stylesheet" type="text/css" href="../../rustdoc.css">
<link rel="stylesheet" type="text/css" href="../../main.css">
<link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
</head>
<body class="rustdoc">
<!--[if lte IE 8]>
<div class="warning">
This old browser is unsupported and will most likely display funky
things.
</div>
<![endif]-->
<nav class="sidebar">
<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'><a href='../index.html'>rand</a>::<wbr><a href='index.html'>chacha</a></p><script>window.sidebarCurrent = {name: 'ChaChaRng', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script>
</nav>
<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">
</div>
</form>
</nav>
<section id='main' class="content struct">
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>rand</a>::<wbr><a href='index.html'>chacha</a>::<wbr><a class='struct' href=''>ChaChaRng</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>
Updated documentation for v1.0.1
2016-05-10 23:34:09 -04:00
</span><a id='src-829' class='srclink' href='../../src/rand/chacha.rs.html#30-34' title='goto source code'>[src]</a></span></h1>
Adding documentation for v0.3
2016-05-10 15:03:32 -04:00
<pre class='rust struct'>pub struct ChaChaRng {
// some fields omitted
}</pre><div class='docblock'><p>A random number generator that uses the ChaCha20 algorithm [1].</p>
<p>The ChaCha algorithm is widely accepted as suitable for
cryptographic purposes, but this implementation has not been
verified as such. Prefer a generator like <code>OsRng</code> that defers to
the operating system for cases that need high security.</p>
<p>[1]: D. J. Bernstein, <a href="http://cr.yp.to/chacha.html"><em>ChaCha, a variant of
Salsa20</em></a></p>
Updated documentation for v1.0.1
2016-05-10 23:34:09 -04:00
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-851' class='srclink' href='../../src/rand/chacha.rs.html#80-155' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.new_unseeded' class='method'><code>fn <a href='#method.new_unseeded' class='fnname'>new_unseeded</a>() -&gt; <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></h4>
Adding documentation for v0.3
2016-05-10 15:03:32 -04:00
<div class='docblock'><p>Create an ChaCha random number generator using the default
fixed key of 8 zero words.</p>
</div><h4 id='method.set_counter' class='method'><code>fn <a href='#method.set_counter' class='fnname'>set_counter</a>(&amp;mut self, counter_low: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u64.html'>u64</a>, counter_high: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u64.html'>u64</a>)</code></h4>
<div class='docblock'><p>Sets the internal 128-bit ChaCha counter to
a user-provided value. This permits jumping
arbitrarily ahead (or backwards) in the pseudorandom stream.</p>
<p>Since the nonce words are used to extend the counter to 128 bits,
users wishing to obtain the conventional ChaCha pseudorandom stream
associated with a particular nonce can call this function with
arguments <code>0, desired_nonce</code>.</p>
Updated documentation for v1.0.1
2016-05-10 23:34:09 -04:00
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='../../rand/trait.Rng.html' title='rand::Rng'>Rng</a> for <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-866' class='srclink' href='../../src/rand/chacha.rs.html#157-168' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.next_u32' class='method'><code>fn <a href='../../rand/trait.Rng.html#tymethod.next_u32' class='fnname'>next_u32</a>(&amp;mut self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a></code></h4>
Adding documentation for v0.3
2016-05-10 15:03:32 -04:00
<h4 id='method.next_u64' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.next_u64' class='fnname'>next_u64</a>(&amp;mut self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u64.html'>u64</a></code></h4>
<h4 id='method.next_f32' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.next_f32' class='fnname'>next_f32</a>(&amp;mut self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.f32.html'>f32</a></code></h4>
<h4 id='method.next_f64' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.next_f64' class='fnname'>next_f64</a>(&amp;mut self) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.f64.html'>f64</a></code></h4>
<h4 id='method.fill_bytes' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.fill_bytes' class='fnname'>fill_bytes</a>(&amp;mut self, dest: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;mut [</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u8.html'>u8</a><a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>)</code></h4>
<h4 id='method.gen' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.gen' class='fnname'>gen</a>&lt;T: <a class='trait' href='../../rand/trait.Rand.html' title='rand::Rand'>Rand</a>&gt;(&amp;mut self) -&gt; T <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
<h4 id='method.gen_iter' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.gen_iter' class='fnname'>gen_iter</a>&lt;'a, T: <a class='trait' href='../../rand/trait.Rand.html' title='rand::Rand'>Rand</a>&gt;(&amp;'a mut self) -&gt; <a class='struct' href='../../rand/struct.Generator.html' title='rand::Generator'>Generator</a>&lt;'a, T, Self&gt; <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
<h4 id='method.gen_range' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.gen_range' class='fnname'>gen_range</a>&lt;T: <a class='trait' href='https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html' title='core::cmp::PartialOrd'>PartialOrd</a> + <a class='trait' href='../../rand/distributions/range/trait.SampleRange.html' title='rand::distributions::range::SampleRange'>SampleRange</a>&gt;(&amp;mut self, low: T, high: T) -&gt; T <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
<h4 id='method.gen_weighted_bool' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.gen_weighted_bool' class='fnname'>gen_weighted_bool</a>(&amp;mut self, n: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.u32.html'>u32</a>) -&gt; <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.bool.html'>bool</a> <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
<h4 id='method.gen_ascii_chars' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.gen_ascii_chars' class='fnname'>gen_ascii_chars</a>&lt;'a&gt;(&amp;'a mut self) -&gt; <a class='struct' href='../../rand/struct.AsciiGenerator.html' title='rand::AsciiGenerator'>AsciiGenerator</a>&lt;'a, Self&gt; <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
<h4 id='method.choose' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.choose' class='fnname'>choose</a>&lt;'a, T&gt;(&amp;mut self, values: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;'a [</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) -&gt; <a class='enum' href='https://doc.rust-lang.org/nightly/core/option/enum.Option.html' title='core::option::Option'>Option</a>&lt;&amp;'a T&gt; <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
<h4 id='method.shuffle' class='method'><code>fn <a href='../../rand/trait.Rng.html#method.shuffle' class='fnname'>shuffle</a>&lt;T&gt;(&amp;mut self, values: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;mut [</a>T<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>]</a>) <span class='where'>where Self: <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html' title='core::marker::Sized'>Sized</a></span></code></h4>
Updated documentation for v1.0.1
2016-05-10 23:34:09 -04:00
</div><h3 class='impl'><span class='in-band'><code>impl&lt;'a&gt; <a class='trait' href='../../rand/trait.SeedableRng.html' title='rand::SeedableRng'>SeedableRng</a>&lt;<a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;'a [</a><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.slice.html'>]</a>&gt; for <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-870' class='srclink' href='../../src/rand/chacha.rs.html#170-191' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.reseed' class='method'><code>fn <a href='../../rand/trait.SeedableRng.html#tymethod.reseed' class='fnname'>reseed</a>(&amp;mut self, seed: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;'a [</a><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.slice.html'>]</a>)</code></h4>
Adding documentation for v0.3
2016-05-10 15:03:32 -04:00
<h4 id='method.from_seed' class='method'><code>fn <a href='../../rand/trait.SeedableRng.html#tymethod.from_seed' class='fnname'>from_seed</a>(seed: <a class='primitive' href='https://doc.rust-lang.org/nightly/std/primitive.slice.html'>&amp;'a [</a><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.slice.html'>]</a>) -&gt; <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></h4>
<div class='docblock'><p>Create a ChaCha generator from a seed,
obtained from a variable-length u32 array.
Only up to 8 words are used; if less than 8
words are used, the remaining are set to zero.</p>
Updated documentation for v1.0.1
2016-05-10 23:34:09 -04:00
</div></div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='../../rand/trait.Rand.html' title='rand::Rand'>Rand</a> for <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-882' class='srclink' href='../../src/rand/chacha.rs.html#193-201' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.rand' class='method'><code>fn <a href='../../rand/trait.Rand.html#tymethod.rand' class='fnname'>rand</a>&lt;R: <a class='trait' href='../../rand/trait.Rng.html' title='rand::Rng'>Rng</a>&gt;(other: &amp;mut R) -&gt; <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></h4>
</div><h3 id='derived_implementations'>Derived Implementations </h3><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html' title='core::clone::Clone'>Clone</a> for <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-835' class='srclink' href='../../src/rand/chacha.rs.html#29' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'><h4 id='method.clone' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#tymethod.clone' class='fnname'>clone</a>(&amp;self) -&gt; <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></h4>
<h4 id='method.clone_from' class='method'><code>fn <a href='https://doc.rust-lang.org/nightly/core/clone/trait.Clone.html#method.clone_from' class='fnname'>clone_from</a>(&amp;mut self, source: &amp;Self)</code><div class="since">1.0.0</div></h4>
</div><h3 class='impl'><span class='in-band'><code>impl <a class='trait' href='https://doc.rust-lang.org/nightly/core/marker/trait.Copy.html' title='core::marker::Copy'>Copy</a> for <a class='struct' href='../../rand/chacha/struct.ChaChaRng.html' title='rand::chacha::ChaChaRng'>ChaChaRng</a></code></span><span class='out-of-band'><div class='ghost'></div><a id='src-841' class='srclink' href='../../src/rand/chacha.rs.html#29' title='goto source code'>[src]</a></span></h3>
<div class='impl-items'></div></section>
Adding documentation for v0.3
2016-05-10 15:03:32 -04:00
<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>?</dt>
<dd>Show this help dialog</dd>
<dt>S</dt>
<dd>Focus the search field</dd>
<dt>&larrb;</dt>
<dd>Move up in search results</dd>
<dt>&rarrb;</dt>
<dd>Move down in search results</dd>
<dt>&#9166;</dt>
<dd>Go to active search result</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>
</div>
</div>
</aside>
<script>
window.rootPath = "../../";
window.currentCrate = "rand";
window.playgroundUrl = "";
</script>
<script src="../../jquery.js"></script>
<script src="../../main.js"></script>
<script defer src="../../search-index.js"></script>
</body>
</html>
Reference in a new issue Copy permalink