|
|
|
|
<!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 `rand_core` crate."><meta name="keywords" content="rust, rustlang, rust-lang, rand_core"><title>rand_core - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc mod"><!--[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">☰</div><a href='../rand_core/index.html'><div class='logo-container'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo'></div></a><p class='location'>Crate rand_core</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all rand_core's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#enums">Enums</a></li><li><a href="#traits">Traits</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'rand_core', ty: 'mod', relpath: '../'};</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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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_core/lib.rs.html#10-46' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>rand_core</a></span></h1><div class='docblock'><p>Random number generation traits</p>
|
|
|
|
|
<p>This version of <code>rand_core</code> is a compatibility shim around version 0.3.</p>
|
|
|
|
|
<p>This crate is mainly of interest to crates publishing implementations of
|
|
|
|
|
[<code>RngCore</code>]. Other users are encouraged to use the <a href="https://docs.rs/rand"><code>rand</code></a> crate instead
|
|
|
|
|
which re-exports the main traits and error types.</p>
|
|
|
|
|
<p>[<code>RngCore</code>] is the core trait implemented by algorithmic pseudo-random number
|
|
|
|
|
generators and external random-number sources.</p>
|
|
|
|
|
<p>[<code>SeedableRng</code>] is an extension trait for construction from fixed seeds and
|
|
|
|
|
other random number generators.</p>
|
|
|
|
|
<p>[<code>Error</code>] is provided for error-handling. It is safe to use in <code>no_std</code>
|
|
|
|
|
environments.</p>
|
|
|
|
|
<p>The [<code>impls</code>] and [<code>le</code>] sub-modules include a few small functions to assist
|
|
|
|
|
implementation of [<code>RngCore</code>].</p>
|
|
|
|
|
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|
|
|
|
<table><tr class='module-item'><td><a class="mod" href="block/index.html" title='rand_core::block mod'>block</a></td><td class='docblock-short'><p>The <code>BlockRngCore</code> trait and implementation helpers</p>
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="impls/index.html" title='rand_core::impls mod'>impls</a></td><td class='docblock-short'><p>Helper functions for implementing <code>RngCore</code> functions.</p>
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="le/index.html" title='rand_core::le mod'>le</a></td><td class='docblock-short'><p>Little-Endian utilities</p>
|
|
|
|
|
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.Error.html" title='rand_core::Error struct'>Error</a></td><td class='docblock-short'><p>Error type of random number generators</p>
|
|
|
|
|
</td></tr></table><h2 id='enums' class='section-header'><a href="#enums">Enums</a></h2>
|
|
|
|
|
<table><tr class='module-item'><td><a class="enum" href="enum.ErrorKind.html" title='rand_core::ErrorKind enum'>ErrorKind</a></td><td class='docblock-short'><p>Error kind which can be matched over.</p>
|
|
|
|
|
</td></tr></table><h2 id='traits' class='section-header'><a href="#traits">Traits</a></h2>
|
|
|
|
|
<table><tr class='module-item'><td><a class="trait" href="trait.CryptoRng.html" title='rand_core::CryptoRng trait'>CryptoRng</a></td><td class='docblock-short'><p>A marker trait used to indicate that an [<code>RngCore</code>] or <a href="block::BlockRngCore"><code>BlockRngCore</code></a>
|
|
|
|
|
implementation is supposed to be cryptographically secure.</p>
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.RngCore.html" title='rand_core::RngCore trait'>RngCore</a></td><td class='docblock-short'><p>The core of a random number generator.</p>
|
|
|
|
|
</td></tr><tr class='module-item'><td><a class="trait" href="trait.SeedableRng.html" title='rand_core::SeedableRng trait'>SeedableRng</a></td><td class='docblock-short'><p>A random number generator that can be explicitly seeded.</p>
|
|
|
|
|
</td></tr></table></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>⏎</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_core";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|