mirror of
https://gitlab.redox-os.org/CoffeeCode/redox-ssh.git
synced 2025-12-28 18:42:18 +01:00
155 lines
No EOL
16 KiB
HTML
155 lines
No EOL
16 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="API documentation for the Rust `ReadRng` struct in crate `rand`.">
|
||
<meta name="keywords" content="rust, rustlang, rust-lang, ReadRng">
|
||
|
||
<title>rand::read::ReadRng - Rust</title>
|
||
|
||
<link rel="stylesheet" type="text/css" href="../../normalize.css">
|
||
<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 struct">
|
||
<!--[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'>Struct ReadRng</p><div class="block items"><ul><li><a href="#methods">Methods</a></li><li><a href="#implementations">Trait Implementations</a></li></ul></div><p class='location'><a href='../index.html'>rand</a>::<wbr><a href='index.html'>read</a></p><script>window.sidebarCurrent = {name: 'ReadRng', 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">
|
||
<h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>rand</a>::<wbr><a href='index.html'>read</a>::<wbr><a class="struct" href=''>ReadRng</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'>−</span>]
|
||
</a>
|
||
</span><a class='srclink' href='../../src/rand/read.rs.html#33-35' title='goto source code'>[src]</a></span></h1>
|
||
<pre class='rust struct'>pub struct ReadRng<R> { /* fields omitted */ }</pre><div class='docblock'><p>An RNG that reads random bytes straight from a <code>Read</code>. This will
|
||
work best with an infinite reader, but this is not required.</p>
|
||
|
||
<h1 id='panics' class='section-header'><a href='#panics'>Panics</a></h1>
|
||
<p>It will panic if it there is insufficient data to fulfill a request.</p>
|
||
|
||
<h1 id='example' class='section-header'><a href='#example'>Example</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">use</span> <span class="ident">rand</span>::{<span class="ident">read</span>, <span class="ident">Rng</span>};
|
||
|
||
<span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>];
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rng</span> <span class="op">=</span> <span class="ident">read</span>::<span class="ident">ReadRng</span>::<span class="ident">new</span>(<span class="kw-2">&</span><span class="ident">data</span>[..]);
|
||
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"{:x}"</span>, <span class="ident">rng</span>.<span class="ident">gen</span>::<span class="op"><</span><span class="ident">u32</span><span class="op">></span>());</pre>
|
||
</div><h2 id='methods'>Methods</h2><h3 class='impl'><span class='in-band'><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> <a class="struct" href="../../rand/read/struct.ReadRng.html" title="struct rand::read::ReadRng">ReadRng</a><R></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#37-44' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>fn <a href='#method.new' class='fnname'>new</a>(r: R) -> <a class="struct" href="../../rand/read/struct.ReadRng.html" title="struct rand::read::ReadRng">ReadRng</a><R></code></span></h4>
|
||
<div class='docblock'><p>Create a new <code>ReadRng</code> from a <code>Read</code>.</p>
|
||
</div></div><h2 id='implementations'>Trait Implementations</h2><h3 class='impl'><span class='in-band'><code>impl<R: <a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>> <a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a> for <a class="struct" href="../../rand/read/struct.ReadRng.html" title="struct rand::read::ReadRng">ReadRng</a><R></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#46-65' title='goto source code'>[src]</a></span></h3>
|
||
<div class='impl-items'><h4 id='method.next_u32' class="method"><span id='next_u32.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#tymethod.next_u32' class='fnname'>next_u32</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span></h4>
|
||
<div class='docblock'><p>Return the next random u32. <a href="../../rand/trait.Rng.html#tymethod.next_u32">Read more</a></p>
|
||
</div><h4 id='method.next_u64' class="method"><span id='next_u64.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.next_u64' class='fnname'>next_u64</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span></h4>
|
||
<div class='docblock'><p>Return the next random u64. <a href="../../rand/trait.Rng.html#method.next_u64">Read more</a></p>
|
||
</div><h4 id='method.fill_bytes' class="method"><span id='fill_bytes.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.fill_bytes' class='fnname'>fill_bytes</a>(&mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&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></span></h4>
|
||
<div class='docblock'><p>Fill <code>dest</code> with random data. <a href="../../rand/trait.Rng.html#method.fill_bytes">Read more</a></p>
|
||
</div><h4 id='method.next_f32' class="method"><span id='next_f32.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.next_f32' class='fnname'>next_f32</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></span></h4>
|
||
<div class='docblock'><p>Return the next random f32 selected from the half-open interval <code>[0, 1)</code>. <a href="../../rand/trait.Rng.html#method.next_f32">Read more</a></p>
|
||
</div><h4 id='method.next_f64' class="method"><span id='next_f64.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.next_f64' class='fnname'>next_f64</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></span></h4>
|
||
<div class='docblock'><p>Return the next random f64 selected from the half-open interval <code>[0, 1)</code>. <a href="../../rand/trait.Rng.html#method.next_f64">Read more</a></p>
|
||
</div><h4 id='method.gen' class="method"><span id='gen.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen' class='fnname'>gen</a><T: <a class="trait" href="../../rand/trait.Rand.html" title="trait rand::Rand">Rand</a>>(&mut self) -> T <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
|
||
<div class='docblock'><p>Return a random value of a <code>Rand</code> type. <a href="../../rand/trait.Rng.html#method.gen">Read more</a></p>
|
||
</div><h4 id='method.gen_iter' class="method"><span id='gen_iter.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen_iter' class='fnname'>gen_iter</a><'a, T: <a class="trait" href="../../rand/trait.Rand.html" title="trait rand::Rand">Rand</a>>(&'a mut self) -> <a class="struct" href="../../rand/struct.Generator.html" title="struct rand::Generator">Generator</a><'a, T, Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
|
||
<div class='docblock'><p>Return an iterator that will yield an infinite number of randomly generated items. <a href="../../rand/trait.Rng.html#method.gen_iter">Read more</a></p>
|
||
</div><h4 id='method.gen_range' class="method"><span id='gen_range.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen_range' class='fnname'>gen_range</a><T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a> + <a class="trait" href="../../rand/distributions/range/trait.SampleRange.html" title="trait rand::distributions::range::SampleRange">SampleRange</a>>(&mut self, low: T, high: T) -> T <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
|
||
<div class='docblock'><p>Generate a random value in the range [<code>low</code>, <code>high</code>). <a href="../../rand/trait.Rng.html#method.gen_range">Read more</a></p>
|
||
</div><h4 id='method.gen_weighted_bool' class="method"><span id='gen_weighted_bool.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen_weighted_bool' class='fnname'>gen_weighted_bool</a>(&mut self, n: <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.bool.html">bool</a> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
|
||
<div class='docblock'><p>Return a bool with a 1 in n chance of true <a href="../../rand/trait.Rng.html#method.gen_weighted_bool">Read more</a></p>
|
||
</div><h4 id='method.gen_ascii_chars' class="method"><span id='gen_ascii_chars.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen_ascii_chars' class='fnname'>gen_ascii_chars</a><'a>(&'a mut self) -> <a class="struct" href="../../rand/struct.AsciiGenerator.html" title="struct rand::AsciiGenerator">AsciiGenerator</a><'a, Self> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
|
||
<div class='docblock'><p>Return an iterator of random characters from the set A-Z,a-z,0-9. <a href="../../rand/trait.Rng.html#method.gen_ascii_chars">Read more</a></p>
|
||
</div><h4 id='method.choose' class="method"><span id='choose.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.choose' class='fnname'>choose</a><'a, T>(&mut self, values: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a T> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
|
||
<div class='docblock'><p>Return a random element from <code>values</code>. <a href="../../rand/trait.Rng.html#method.choose">Read more</a></p>
|
||
</div><h4 id='method.choose_mut' class="method"><span id='choose_mut.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.choose_mut' class='fnname'>choose_mut</a><'a, T>(&mut self, values: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&'a mut [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><&'a mut T> <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
|
||
<div class='docblock'><p>Return a mutable pointer to a random element from <code>values</code>. <a href="../../rand/trait.Rng.html#method.choose_mut">Read more</a></p>
|
||
</div><h4 id='method.shuffle' class="method"><span id='shuffle.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.shuffle' class='fnname'>shuffle</a><T>(&mut self, values: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&mut [</a>T<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>) <span class="where fmt-newline">where<br> Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>, </span></code></span></h4>
|
||
<div class='docblock'><p>Shuffle a mutable slice in place. <a href="../../rand/trait.Rng.html#method.shuffle">Read more</a></p>
|
||
</div></div></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>?</dt>
|
||
<dd>Show this help dialog</dd>
|
||
<dt>S</dt>
|
||
<dd>Focus the search field</dd>
|
||
<dt>⇤</dt>
|
||
<dd>Move up in search results</dd>
|
||
<dt>⇥</dt>
|
||
<dd>Move down in search results</dd>
|
||
<dt>⏎</dt>
|
||
<dd>Go to active search result</dd>
|
||
<dt>+</dt>
|
||
<dd>Collapse/expand 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>
|
||
</div>
|
||
</div>
|
||
</aside>
|
||
|
||
|
||
|
||
<script>
|
||
window.rootPath = "../../";
|
||
window.currentCrate = "rand";
|
||
</script>
|
||
<script src="../../main.js"></script>
|
||
<script defer src="../../search-index.js"></script>
|
||
</body>
|
||
</html> |