blob: 4a1d8f83df43c19d648ee973a0f9b346897457b9 [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="Random number generation traits"><meta name="keywords" content="rust, rustlang, rust-lang, rand_core"><title>rand_core - 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" type="text/css" href="../normalize.css"><link rel="stylesheet" type="text/css" href="../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" type="text/css" href="../ayu.css" disabled><link rel="stylesheet" type="text/css" href="../dark.css" disabled><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../storage.js"></script><script src="../crates.js"></script><script defer src="../main.js"></script>
<noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="https:&#x2F;&#x2F;www.rust-lang.org&#x2F;favicon.ico"></head><body class="rustdoc mod crate"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu" role="button">&#9776;</div><a class="sidebar-logo" href="../rand_core/index.html"><div class="logo-container"><img src="https:&#x2F;&#x2F;www.rust-lang.org&#x2F;logos&#x2F;rust-logo-128x128-blk.png" alt="logo"></div>
</a><h2 class="location">Crate rand_core</h2><div class="block version"><div class="narrow-helper"></div><p>Version 0.6.4</p></div><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="#traits">Traits</a></li></ul></div><div id="sidebar-vars" data-name="rand_core" data-ty="mod" data-relpath=""></div><script defer src="sidebar-items.js"></script></div></nav><main><div class="width-limiter"><div class="sub-container"><a class="sub-logo-container" href="../rand_core/index.html"><img src="https:&#x2F;&#x2F;www.rust-lang.org&#x2F;logos&#x2F;rust-logo-128x128-blk.png" alt="logo"></a><nav class="sub"><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="18" height="18" alt="Pick another theme!" src="../brush.svg"></button><div id="theme-choices" role="menu"></div></div><form class="search-form"><div class="search-container"><div>
<input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../settings.html" title="settings"><img width="18" height="18" alt="Change settings" src="../wheel.svg"></a></div></form></nav></div><section id="main-content" class="content"><div class="main-heading">
<h1 class="fqn"><span class="in-band">Crate <a class="mod" href="#">rand_core</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></span></h1><span class="out-of-band">
<a class="srclink" href="../src/rand_core/lib.rs.html#10-531" title="goto source code">source</a> ·
<a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">&#x2212;</span>]</a></span></div>
<details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Random number generation traits</p>
<p>This crate is mainly of interest to crates publishing implementations of
<a href="trait.RngCore.html" title="RngCore"><code>RngCore</code></a>. 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><a href="trait.RngCore.html" title="RngCore"><code>RngCore</code></a> is the core trait implemented by algorithmic pseudo-random number
generators and external random-number sources.</p>
<p><a href="trait.SeedableRng.html" title="SeedableRng"><code>SeedableRng</code></a> is an extension trait for construction from fixed seeds and
other random number generators.</p>
<p><a href="struct.Error.html" title="Error"><code>Error</code></a> is provided for error-handling. It is safe to use in <code>no_std</code>
environments.</p>
<p>The <a href="impls/index.html" title="impls"><code>impls</code></a> and <a href="le/index.html" title="le"><code>le</code></a> sub-modules include a few small functions to assist
implementation of <a href="trait.RngCore.html" title="RngCore"><code>RngCore</code></a>.</p>
</div></details><h2 id="modules" class="small-section-header"><a href="#modules">Modules</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="mod" href="block/index.html" title="rand_core::block mod">block</a></div><div class="item-right docblock-short"><p>The <code>BlockRngCore</code> trait and implementation helpers</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="impls/index.html" title="rand_core::impls mod">impls</a></div><div class="item-right docblock-short"><p>Helper functions for implementing <code>RngCore</code> functions.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="mod" href="le/index.html" title="rand_core::le mod">le</a></div><div class="item-right docblock-short"><p>Little-Endian utilities</p>
</div></div></div><h2 id="structs" class="small-section-header"><a href="#structs">Structs</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.Error.html" title="rand_core::Error struct">Error</a></div><div class="item-right docblock-short"><p>Error type of random number generators</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="struct" href="struct.OsRng.html" title="rand_core::OsRng struct">OsRng</a><span class="stab portability" title="This is supported on crate feature `getrandom` only"><code>getrandom</code></span></div><div class="item-right docblock-short"><p>A random number generator that retrieves randomness from the
operating system.</p>
</div></div></div><h2 id="traits" class="small-section-header"><a href="#traits">Traits</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CryptoRng.html" title="rand_core::CryptoRng trait">CryptoRng</a></div><div class="item-right docblock-short"><p>A marker trait used to indicate that an <a href="trait.RngCore.html" title="RngCore"><code>RngCore</code></a> or <a href="block/trait.BlockRngCore.html"><code>BlockRngCore</code></a>
implementation is supposed to be cryptographically secure.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.CryptoRngCore.html" title="rand_core::CryptoRngCore trait">CryptoRngCore</a></div><div class="item-right docblock-short"><p>An extension trait that is automatically implemented for any type
implementing <a href="trait.RngCore.html" title="RngCore"><code>RngCore</code></a> and <a href="trait.CryptoRng.html" title="CryptoRng"><code>CryptoRng</code></a>.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.RngCore.html" title="rand_core::RngCore trait">RngCore</a></div><div class="item-right docblock-short"><p>The core of a random number generator.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="trait" href="trait.SeedableRng.html" title="rand_core::SeedableRng trait">SeedableRng</a></div><div class="item-right docblock-short"><p>A random number generator that can be explicitly seeded.</p>
</div></div></div></section><section id="search" class="content hidden"></section></div></main><div id="rustdoc-vars" data-root-path="../" data-current-crate="rand_core" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.60.0-nightly (1bd4fdc94 2022-01-12)" ></div>
</body></html>