|
|
<!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="`String` sampler"><meta name="keywords" content="rust, rustlang, rust-lang, DistString"><title>DistString in rand::distributions - 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="icon" href="https://www.rust-lang.org/favicon.ico"></head><body class="rustdoc trait"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button><a class="sidebar-logo" href="../../rand/index.html"><div class="logo-container"><img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></div>
|
|
|
</a><h2 class="location"></h2>
|
|
|
</nav>
|
|
|
<nav class="sidebar"><a class="sidebar-logo" href="../../rand/index.html"><div class="logo-container">
|
|
|
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></div>
|
|
|
</a><h2 class="location"><a href="#">DistString</a></h2><div class="sidebar-elems"><section><div class="block"><h3 class="sidebar-title"><a href="#required-methods">Required Methods</a></h3><ul><li><a href="#tymethod.append_string">append_string</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#provided-methods">Provided Methods</a></h3><ul><li><a href="#method.sample_string">sample_string</a></li></ul></div><div class="block"><h3 class="sidebar-title"><a href="#implementors">Implementors</a></h3></div></section><h2 class="location"><a href="index.html">In rand::distributions</a></h2><div id="sidebar-vars" data-name="DistString" data-ty="trait" 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/index.html">
|
|
|
<img src="https://www.rust-lang.org/logos/rust-logo-128x128-blk.png" alt="logo"></a><nav class="sub"><div class="theme-picker hidden"><button id="theme-picker" aria-label="Pick another theme!" aria-haspopup="menu" title="themes"><img width="22" height="22" alt="Pick another theme!" src="../../brush.svg"></button><div id="theme-choices" role="menu"></div></div><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"><button type="button" id="help-button" title="help">?</button><a id="settings-menu" href="../../settings.html" title="settings"><img width="22" height="22" 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">Trait <a href="../index.html">rand</a>::<wbr><a href="index.html">distributions</a>::<wbr><a class="trait" href="#">DistString</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/distributions/distribution.rs.html#197-208">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="docblock item-decl"><pre class="rust trait"><code>pub trait DistString {
|
|
|
fn <a href="#tymethod.append_string" class="fnname">append_string</a><R: <a class="trait" href="../trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &self, <br> rng: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.reference.html">&mut </a>R, <br> string: &mut <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <br> len: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.usize.html">usize</a><br> );
|
|
|
|
|
|
fn <a href="#method.sample_string" class="fnname">sample_string</a><R: <a class="trait" href="../trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, rng: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.reference.html">&mut </a>R, len: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> { ... }
|
|
|
}</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>String</code> sampler</p>
|
|
|
<p>Sampling a <code>String</code> of random characters is not quite the same as collecting
|
|
|
a sequence of chars. This trait contains some helpers.</p>
|
|
|
</div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="tymethod.append_string" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/rand/distributions/distribution.rs.html#199">source</a></div><h4 class="code-header">fn <a href="#tymethod.append_string" class="fnname">append_string</a><R: <a class="trait" href="../trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(<br> &self, <br> rng: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.reference.html">&mut </a>R, <br> string: &mut <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a>, <br> len: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.usize.html">usize</a><br>)</h4></div></summary><div class="docblock"><p>Append <code>len</code> random chars to <code>string</code></p>
|
|
|
</div></details></div><h2 id="provided-methods" class="small-section-header">Provided Methods<a href="#provided-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle" open><summary><div id="method.sample_string" class="method has-srclink"><div class="rightside"><a class="srclink" href="../../src/rand/distributions/distribution.rs.html#203-207">source</a></div><h4 class="code-header">fn <a href="#method.sample_string" class="fnname">sample_string</a><R: <a class="trait" href="../trait.Rng.html" title="trait rand::Rng">Rng</a> + ?<a class="trait" href="https://doc.rust-lang.org/1.62.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>>(&self, rng: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.reference.html">&mut </a>R, len: <a class="primitive" href="https://doc.rust-lang.org/1.62.1/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/1.62.1/alloc/string/struct.String.html" title="struct alloc::string::String">String</a></h4></div></summary><div class="docblock"><p>Generate a <code>String</code> of <code>len</code> random chars</p>
|
|
|
</div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div class="item-list" id="implementors-list"><section id="impl-DistString" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/rand/distributions/other.rs.html#128-135">source</a></span><a href="#impl-DistString" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.DistString.html" title="trait rand::distributions::DistString">DistString</a> for <a class="struct" href="struct.Alphanumeric.html" title="struct rand::distributions::Alphanumeric">Alphanumeric</a></h3></section><section id="impl-DistString-1" class="impl has-srclink"><span class="rightside"><a class="srclink" href="../../src/rand/distributions/other.rs.html#98-106">source</a></span><a href="#impl-DistString-1" class="anchor"></a><h3 class="code-header in-band">impl <a class="trait" href="trait.DistString.html" title="trait rand::distributions::DistString">DistString</a> for <a class="struct" href="struct.Standard.html" title="struct rand::distributions::Standard">Standard</a></h3></section><div class="docblock"><p>Note: the <code>String</code> is potentially left with excess capacity; optionally the
|
|
|
user may call <code>string.shrink_to_fit()</code> afterwards.</p>
|
|
|
</div></div><script type="text/javascript" src="../../implementors/rand/distributions/distribution/trait.DistString.js" data-ignore-extern-crates="" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rand" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.62.1 (e092d0b6b 2022-07-16)" ></div>
|
|
|
</body></html> |
