blob: 911220d7aab1b23827151f25c99d8104bcde702e [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="Source of the Rust file `/root/.cargo/git/checkouts/incubator-teaclave-crates-c8106113f74feefc/ede1f68/rand/rand_core/src/impls.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>impls.rs - source</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" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="../../source-script.js"></script><script defer src="../../source-files.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><a class="sidebar-logo" 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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../rand_core/index.html">
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
</pre><pre class="rust"><code><span class="comment">// Copyright 2018 Developers of the Rand project.
//
// Licensed under the Apache License, Version 2.0 &lt;LICENSE-APACHE or
// https://www.apache.org/licenses/LICENSE-2.0&gt; or the MIT license
// &lt;LICENSE-MIT or https://opensource.org/licenses/MIT&gt;, at your
// option. This file may not be copied, modified, or distributed
// except according to those terms.
</span><span class="doccomment">//! Helper functions for implementing `RngCore` functions.
//!
//! For cross-platform reproducibility, these functions all use Little Endian:
//! least-significant part first. For example, `next_u64_via_u32` takes `u32`
//! values `x, y`, then outputs `(y &lt;&lt; 32) | x`. To implement `next_u32`
//! from `next_u64` in little-endian order, one should use `next_u64() as u32`.
//!
//! Byte-swapping (like the std `to_le` functions) is only needed to convert
//! to/from byte sequences, and since its purpose is reproducibility,
//! non-reproducible sources (e.g. `OsRng`) need not bother with it.
</span><span class="kw">use </span><span class="kw">crate</span>::RngCore;
<span class="kw">use </span>core::cmp::min;
<span class="doccomment">/// Implement `next_u64` via `next_u32`, little-endian order.
</span><span class="kw">pub fn </span>next_u64_via_u32&lt;R: RngCore + <span class="question-mark">?</span>Sized&gt;(rng: <span class="kw-2">&amp;mut </span>R) -&gt; u64 {
<span class="comment">// Use LE; we explicitly generate one value before the next.
</span><span class="kw">let </span>x = u64::from(rng.next_u32());
<span class="kw">let </span>y = u64::from(rng.next_u32());
(y &lt;&lt; <span class="number">32</span>) | x
}
<span class="doccomment">/// Implement `fill_bytes` via `next_u64` and `next_u32`, little-endian order.
///
/// The fastest way to fill a slice is usually to work as long as possible with
/// integers. That is why this method mostly uses `next_u64`, and only when
/// there are 4 or less bytes remaining at the end of the slice it uses
/// `next_u32` once.
</span><span class="kw">pub fn </span>fill_bytes_via_next&lt;R: RngCore + <span class="question-mark">?</span>Sized&gt;(rng: <span class="kw-2">&amp;mut </span>R, dest: <span class="kw-2">&amp;mut </span>[u8]) {
<span class="kw">let </span><span class="kw-2">mut </span>left = dest;
<span class="kw">while </span>left.len() &gt;= <span class="number">8 </span>{
<span class="kw">let </span>(l, r) = { left }.split_at_mut(<span class="number">8</span>);
left = r;
<span class="kw">let </span>chunk: [u8; <span class="number">8</span>] = rng.next_u64().to_le_bytes();
l.copy_from_slice(<span class="kw-2">&amp;</span>chunk);
}
<span class="kw">let </span>n = left.len();
<span class="kw">if </span>n &gt; <span class="number">4 </span>{
<span class="kw">let </span>chunk: [u8; <span class="number">8</span>] = rng.next_u64().to_le_bytes();
left.copy_from_slice(<span class="kw-2">&amp;</span>chunk[..n]);
} <span class="kw">else if </span>n &gt; <span class="number">0 </span>{
<span class="kw">let </span>chunk: [u8; <span class="number">4</span>] = rng.next_u32().to_le_bytes();
left.copy_from_slice(<span class="kw-2">&amp;</span>chunk[..n]);
}
}
<span class="kw">trait </span>Observable: Copy {
<span class="kw">type </span>Bytes: AsRef&lt;[u8]&gt;;
<span class="kw">fn </span>to_le_bytes(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Bytes;
<span class="comment">// Contract: observing self is memory-safe (implies no uninitialised padding)
</span><span class="kw">fn </span>as_byte_slice(x: <span class="kw-2">&amp;</span>[<span class="self">Self</span>]) -&gt; <span class="kw-2">&amp;</span>[u8];
}
<span class="kw">impl </span>Observable <span class="kw">for </span>u32 {
<span class="kw">type </span>Bytes = [u8; <span class="number">4</span>];
<span class="kw">fn </span>to_le_bytes(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Bytes {
<span class="self">self</span>.to_le_bytes()
}
<span class="kw">fn </span>as_byte_slice(x: <span class="kw-2">&amp;</span>[<span class="self">Self</span>]) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="kw">let </span>ptr = x.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span>u8;
<span class="kw">let </span>len = x.len() * core::mem::size_of::&lt;<span class="self">Self</span>&gt;();
<span class="kw">unsafe </span>{ core::slice::from_raw_parts(ptr, len) }
}
}
<span class="kw">impl </span>Observable <span class="kw">for </span>u64 {
<span class="kw">type </span>Bytes = [u8; <span class="number">8</span>];
<span class="kw">fn </span>to_le_bytes(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Bytes {
<span class="self">self</span>.to_le_bytes()
}
<span class="kw">fn </span>as_byte_slice(x: <span class="kw-2">&amp;</span>[<span class="self">Self</span>]) -&gt; <span class="kw-2">&amp;</span>[u8] {
<span class="kw">let </span>ptr = x.as_ptr() <span class="kw">as </span><span class="kw-2">*const </span>u8;
<span class="kw">let </span>len = x.len() * core::mem::size_of::&lt;<span class="self">Self</span>&gt;();
<span class="kw">unsafe </span>{ core::slice::from_raw_parts(ptr, len) }
}
}
<span class="kw">fn </span>fill_via_chunks&lt;T: Observable&gt;(src: <span class="kw-2">&amp;</span>[T], dest: <span class="kw-2">&amp;mut </span>[u8]) -&gt; (usize, usize) {
<span class="kw">let </span>size = core::mem::size_of::&lt;T&gt;();
<span class="kw">let </span>byte_len = min(src.len() * size, dest.len());
<span class="kw">let </span>num_chunks = (byte_len + size - <span class="number">1</span>) / size;
<span class="kw">if </span><span class="macro">cfg!</span>(target_endian = <span class="string">&quot;little&quot;</span>) {
<span class="comment">// On LE we can do a simple copy, which is 25-50% faster:
</span>dest[..byte_len].copy_from_slice(<span class="kw-2">&amp;</span>T::as_byte_slice(<span class="kw-2">&amp;</span>src[..num_chunks])[..byte_len]);
} <span class="kw">else </span>{
<span class="comment">// This code is valid on all arches, but slower than the above:
</span><span class="kw">let </span><span class="kw-2">mut </span>i = <span class="number">0</span>;
<span class="kw">let </span><span class="kw-2">mut </span>iter = dest[..byte_len].chunks_exact_mut(size);
<span class="kw">for </span>chunk <span class="kw">in </span><span class="kw-2">&amp;mut </span>iter {
chunk.copy_from_slice(src[i].to_le_bytes().as_ref());
i += <span class="number">1</span>;
}
<span class="kw">let </span>chunk = iter.into_remainder();
<span class="kw">if </span>!chunk.is_empty() {
chunk.copy_from_slice(<span class="kw-2">&amp;</span>src[i].to_le_bytes().as_ref()[..chunk.len()]);
}
}
(num_chunks, byte_len)
}
<span class="doccomment">/// Implement `fill_bytes` by reading chunks from the output buffer of a block
/// based RNG.
///
/// The return values are `(consumed_u32, filled_u8)`.
///
/// `filled_u8` is the number of filled bytes in `dest`, which may be less than
/// the length of `dest`.
/// `consumed_u32` is the number of words consumed from `src`, which is the same
/// as `filled_u8 / 4` rounded up.
///
/// # Example
/// (from `IsaacRng`)
///
/// ```ignore
/// fn fill_bytes(&amp;mut self, dest: &amp;mut [u8]) {
/// let mut read_len = 0;
/// while read_len &lt; dest.len() {
/// if self.index &gt;= self.rsl.len() {
/// self.isaac();
/// }
///
/// let (consumed_u32, filled_u8) =
/// impls::fill_via_u32_chunks(&amp;mut self.rsl[self.index..],
/// &amp;mut dest[read_len..]);
///
/// self.index += consumed_u32;
/// read_len += filled_u8;
/// }
/// }
/// ```
</span><span class="kw">pub fn </span>fill_via_u32_chunks(src: <span class="kw-2">&amp;</span>[u32], dest: <span class="kw-2">&amp;mut </span>[u8]) -&gt; (usize, usize) {
fill_via_chunks(src, dest)
}
<span class="doccomment">/// Implement `fill_bytes` by reading chunks from the output buffer of a block
/// based RNG.
///
/// The return values are `(consumed_u64, filled_u8)`.
/// `filled_u8` is the number of filled bytes in `dest`, which may be less than
/// the length of `dest`.
/// `consumed_u64` is the number of words consumed from `src`, which is the same
/// as `filled_u8 / 8` rounded up.
///
/// See `fill_via_u32_chunks` for an example.
</span><span class="kw">pub fn </span>fill_via_u64_chunks(src: <span class="kw-2">&amp;</span>[u64], dest: <span class="kw-2">&amp;mut </span>[u8]) -&gt; (usize, usize) {
fill_via_chunks(src, dest)
}
<span class="doccomment">/// Implement `next_u32` via `fill_bytes`, little-endian order.
</span><span class="kw">pub fn </span>next_u32_via_fill&lt;R: RngCore + <span class="question-mark">?</span>Sized&gt;(rng: <span class="kw-2">&amp;mut </span>R) -&gt; u32 {
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">4</span>];
rng.fill_bytes(<span class="kw-2">&amp;mut </span>buf);
u32::from_le_bytes(buf)
}
<span class="doccomment">/// Implement `next_u64` via `fill_bytes`, little-endian order.
</span><span class="kw">pub fn </span>next_u64_via_fill&lt;R: RngCore + <span class="question-mark">?</span>Sized&gt;(rng: <span class="kw-2">&amp;mut </span>R) -&gt; u64 {
<span class="kw">let </span><span class="kw-2">mut </span>buf = [<span class="number">0</span>; <span class="number">8</span>];
rng.fill_bytes(<span class="kw-2">&amp;mut </span>buf);
u64::from_le_bytes(buf)
}
<span class="attribute">#[cfg(test)]
</span><span class="kw">mod </span>test {
<span class="kw">use super</span>::<span class="kw-2">*</span>;
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_fill_via_u32_chunks() {
<span class="kw">let </span>src = [<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
<span class="kw">let </span><span class="kw-2">mut </span>dst = [<span class="number">0u8</span>; <span class="number">11</span>];
<span class="macro">assert_eq!</span>(fill_via_u32_chunks(<span class="kw-2">&amp;</span>src, <span class="kw-2">&amp;mut </span>dst), (<span class="number">3</span>, <span class="number">11</span>));
<span class="macro">assert_eq!</span>(dst, [<span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">0</span>]);
<span class="kw">let </span><span class="kw-2">mut </span>dst = [<span class="number">0u8</span>; <span class="number">13</span>];
<span class="macro">assert_eq!</span>(fill_via_u32_chunks(<span class="kw-2">&amp;</span>src, <span class="kw-2">&amp;mut </span>dst), (<span class="number">3</span>, <span class="number">12</span>));
<span class="macro">assert_eq!</span>(dst, [<span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">3</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]);
<span class="kw">let </span><span class="kw-2">mut </span>dst = [<span class="number">0u8</span>; <span class="number">5</span>];
<span class="macro">assert_eq!</span>(fill_via_u32_chunks(<span class="kw-2">&amp;</span>src, <span class="kw-2">&amp;mut </span>dst), (<span class="number">2</span>, <span class="number">5</span>));
<span class="macro">assert_eq!</span>(dst, [<span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">2</span>]);
}
<span class="attribute">#[test]
</span><span class="kw">fn </span>test_fill_via_u64_chunks() {
<span class="kw">let </span>src = [<span class="number">1</span>, <span class="number">2</span>];
<span class="kw">let </span><span class="kw-2">mut </span>dst = [<span class="number">0u8</span>; <span class="number">11</span>];
<span class="macro">assert_eq!</span>(fill_via_u64_chunks(<span class="kw-2">&amp;</span>src, <span class="kw-2">&amp;mut </span>dst), (<span class="number">2</span>, <span class="number">11</span>));
<span class="macro">assert_eq!</span>(dst, [<span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">0</span>]);
<span class="kw">let </span><span class="kw-2">mut </span>dst = [<span class="number">0u8</span>; <span class="number">17</span>];
<span class="macro">assert_eq!</span>(fill_via_u64_chunks(<span class="kw-2">&amp;</span>src, <span class="kw-2">&amp;mut </span>dst), (<span class="number">2</span>, <span class="number">16</span>));
<span class="macro">assert_eq!</span>(dst, [<span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">2</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]);
<span class="kw">let </span><span class="kw-2">mut </span>dst = [<span class="number">0u8</span>; <span class="number">5</span>];
<span class="macro">assert_eq!</span>(fill_via_u64_chunks(<span class="kw-2">&amp;</span>src, <span class="kw-2">&amp;mut </span>dst), (<span class="number">1</span>, <span class="number">5</span>));
<span class="macro">assert_eq!</span>(dst, [<span class="number">1</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>, <span class="number">0</span>]);
}
}
</code></pre></div>
</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.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>