Files
GopherGate/target/doc/rand/fn.random.html
2026-02-26 12:00:21 -05:00

29 lines
5.4 KiB
HTML
Raw Blame History

This file contains ambiguous Unicode characters
This file contains Unicode characters that might be confused with other characters. If you think that this is intentional, you can safely ignore this warning. Use the Escape button to reveal them.
<!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="Generate a random value using the thread-local random number generator."><title>random in rand - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rand" data-themes="" data-resource-suffix="" data-rustdoc-version="1.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><rustdoc-topbar><h2><a href="#">random</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><a class="logo-container" href="../rand/index.html"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><h2><a href="../rand/index.html">rand</a><span class="version">0.9.2</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">random</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate rand</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">rand</a></div><h1>Function <span class="fn">random</span>&nbsp;<button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/rand/lib.rs.html#172-177">Source</a> </span></div><pre class="rust item-decl"><code>pub fn random&lt;T&gt;() -&gt; T<div class="where">where
<a class="struct" href="distr/struct.StandardUniform.html" title="struct rand::distr::StandardUniform">StandardUniform</a>: <a class="trait" href="distr/trait.Distribution.html" title="trait rand::distr::Distribution">Distribution</a>&lt;T&gt;,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Generate a random value using the thread-local random number generator.</p>
<p>This function is shorthand for <code><a href="fn.rng.html" title="fn rand::rng">rng()</a>.<a href="trait.Rng.html#method.random" title="method rand::Rng::random">random()</a></code>:</p>
<ul>
<li>See <a href="rngs/struct.ThreadRng.html" title="struct rand::rngs::ThreadRng"><code>ThreadRng</code></a> for documentation of the generator and security</li>
<li>See <a href="distr/struct.StandardUniform.html" title="struct rand::distr::StandardUniform"><code>StandardUniform</code></a> for documentation of supported types and distributions</li>
</ul>
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">let </span>x = rand::random::&lt;u8&gt;();
<span class="macro">println!</span>(<span class="string">"{}"</span>, x);
<span class="kw">let </span>y = rand::random::&lt;f64&gt;();
<span class="macro">println!</span>(<span class="string">"{}"</span>, y);
<span class="kw">if </span>rand::random() { <span class="comment">// generates a boolean
</span><span class="macro">println!</span>(<span class="string">"Better lucky than good!"</span>);
}</code></pre></div>
<p>If youre calling <code>random()</code> repeatedly, consider using a local <code>rng</code>
handle to save an initialization-check on each usage:</p>
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rand::Rng; <span class="comment">// provides the `random` method
</span><span class="kw">let </span><span class="kw-2">mut </span>rng = rand::rng(); <span class="comment">// a local handle to the generator
</span><span class="kw">let </span><span class="kw-2">mut </span>v = <span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>];
<span class="kw">for </span>x <span class="kw">in </span>v.iter_mut() {
<span class="kw-2">*</span>x = rng.random();
}</code></pre></div></div></details></section></div></main></body></html>