blob: 8d2369680efdbd91174259105bfe571c0b052c9a [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="Helper functions for implementing `RngCore` functions."><meta name="keywords" content="rust, rustlang, rust-lang, impls"><title>rand_core::impls - 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"><!--[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">Module impls</h2><div class="sidebar-elems"><div class="block items"><ul><li><a href="#functions">Functions</a></li></ul></div><div id="sidebar-vars" data-name="impls" 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">Module <a href="../index.html">rand_core</a>::<wbr><a class="mod" href="#">impls</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/impls.rs.html#9-207" 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>Helper functions for implementing <code>RngCore</code> functions.</p>
<p>For cross-platform reproducibility, these functions all use Little Endian:
least-significant part first. For example, <code>next_u64_via_u32</code> takes <code>u32</code>
values <code>x, y</code>, then outputs <code>(y &lt;&lt; 32) | x</code>. To implement <code>next_u32</code>
from <code>next_u64</code> in little-endian order, one should use <code>next_u64() as u32</code>.</p>
<p>Byte-swapping (like the std <code>to_le</code> functions) is only needed to convert
to/from byte sequences, and since its purpose is reproducibility,
non-reproducible sources (e.g. <code>OsRng</code>) need not bother with it.</p>
</div></details><h2 id="functions" class="small-section-header"><a href="#functions">Functions</a></h2>
<div class="item-table"><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.fill_bytes_via_next.html" title="rand_core::impls::fill_bytes_via_next fn">fill_bytes_via_next</a></div><div class="item-right docblock-short"><p>Implement <code>fill_bytes</code> via <code>next_u64</code> and <code>next_u32</code>, little-endian order.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.fill_via_u32_chunks.html" title="rand_core::impls::fill_via_u32_chunks fn">fill_via_u32_chunks</a></div><div class="item-right docblock-short"><p>Implement <code>fill_bytes</code> by reading chunks from the output buffer of a block
based RNG.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.fill_via_u64_chunks.html" title="rand_core::impls::fill_via_u64_chunks fn">fill_via_u64_chunks</a></div><div class="item-right docblock-short"><p>Implement <code>fill_bytes</code> by reading chunks from the output buffer of a block
based RNG.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.next_u32_via_fill.html" title="rand_core::impls::next_u32_via_fill fn">next_u32_via_fill</a></div><div class="item-right docblock-short"><p>Implement <code>next_u32</code> via <code>fill_bytes</code>, little-endian order.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.next_u64_via_fill.html" title="rand_core::impls::next_u64_via_fill fn">next_u64_via_fill</a></div><div class="item-right docblock-short"><p>Implement <code>next_u64</code> via <code>fill_bytes</code>, little-endian order.</p>
</div></div><div class="item-row"><div class="item-left module-item"><a class="fn" href="fn.next_u64_via_u32.html" title="rand_core::impls::next_u64_via_u32 fn">next_u64_via_u32</a></div><div class="item-right docblock-short"><p>Implement <code>next_u64</code> via <code>next_u32</code>, little-endian order.</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>