struct.ReadRng.html 23 KB

123456789101112131415161718192021222324252627282930313233343536373839404142434445464748495051525354555657585960616263646566676869707172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4. <meta charset="utf-8">
  5. <meta name="viewport" content="width=device-width, initial-scale=1.0">
  6. <meta name="generator" content="rustdoc">
  7. <meta name="description" content="API documentation for the Rust `ReadRng` struct in crate `rand`.">
  8. <meta name="keywords" content="rust, rustlang, rust-lang, ReadRng">
  9. <title>rand::read::ReadRng - Rust</title>
  10. <link rel="stylesheet" type="text/css" href="../../normalize.css">
  11. <link rel="stylesheet" type="text/css" href="../../rustdoc.css" id="mainThemeStyle">
  12. <link rel="stylesheet" type="text/css" href="../../dark.css">
  13. <link rel="stylesheet" type="text/css" href="../../main.css" id="themeStyle">
  14. <script src="../../storage.js"></script>
  15. <link rel="shortcut icon" href="https://www.rust-lang.org/favicon.ico">
  16. </head>
  17. <body class="rustdoc struct">
  18. <!--[if lte IE 8]>
  19. <div class="warning">
  20. This old browser is unsupported and will most likely display funky
  21. things.
  22. </div>
  23. <![endif]-->
  24. <nav class="sidebar">
  25. <div class="sidebar-menu">&#9776;</div>
  26. <a href='../../rand/index.html'><img src='https://www.rust-lang.org/logos/rust-logo-128x128-blk.png' alt='logo' width='100'></a>
  27. <p class='location'>Struct ReadRng</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.new">new</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Rng">Rng</a></div></div><p class='location'><a href='../index.html'>rand</a>::<wbr><a href='index.html'>read</a></p><script>window.sidebarCurrent = {name: 'ReadRng', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div>
  28. </nav>
  29. <div class="theme-picker">
  30. <button id="theme-picker" aria-label="Pick another theme!">
  31. <img src="../../brush.svg" width="18" alt="Pick another theme!">
  32. </button>
  33. <div id="theme-choices"></div>
  34. </div>
  35. <script src="../../theme.js"></script>
  36. <nav class="sub">
  37. <form class="search-form js-only">
  38. <div class="search-container">
  39. <input class="search-input" name="search"
  40. autocomplete="off"
  41. placeholder="Click or press ‘S’ to search, ‘?’ for more options…"
  42. type="search">
  43. </div>
  44. </form>
  45. </nav>
  46. <section id='main' class="content">
  47. <h1 class='fqn'><span class='in-band'>Struct <a href='../index.html'>rand</a>::<wbr><a href='index.html'>read</a>::<wbr><a class="struct" href=''>ReadRng</a></span><span class='out-of-band'><span id='render-detail'>
  48. <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">
  49. [<span class='inner'>&#x2212;</span>]
  50. </a>
  51. </span><a class='srclink' href='../../src/rand/read.rs.html#34-36' title='goto source code'>[src]</a></span></h1>
  52. <pre class='rust struct'>pub struct ReadRng&lt;R&gt; { /* fields omitted */ }</pre><div class='docblock'><p>An RNG that reads random bytes straight from a <code>Read</code>. This will
  53. work best with an infinite reader, but this is not required.</p>
  54. <h1 id="panics" class="section-header"><a href="#panics">Panics</a></h1>
  55. <p>It will panic if it there is insufficient data to fulfill a request.</p>
  56. <h1 id="example" class="section-header"><a href="#example">Example</a></h1>
  57. <pre class="rust rust-example-rendered">
  58. <span class="kw">use</span> <span class="ident">rand</span>::{<span class="ident">read</span>, <span class="ident">Rng</span>};
  59. <span class="kw">let</span> <span class="ident">data</span> <span class="op">=</span> <span class="macro">vec</span><span class="macro">!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>, <span class="number">4</span>, <span class="number">5</span>, <span class="number">6</span>, <span class="number">7</span>, <span class="number">8</span>];
  60. <span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">rng</span> <span class="op">=</span> <span class="ident">read</span>::<span class="ident">ReadRng</span>::<span class="ident">new</span>(<span class="kw-2">&amp;</span><span class="ident">data</span>[..]);
  61. <span class="macro">println</span><span class="macro">!</span>(<span class="string">&quot;{:x}&quot;</span>, <span class="ident">rng</span>.<span class="ident">gen</span>::<span class="op">&lt;</span><span class="ident">u32</span><span class="op">&gt;</span>());</pre>
  62. </div>
  63. <h2 id='methods' class='small-section-header'>
  64. Methods<a href='#methods' class='anchor'></a>
  65. </h2>
  66. <h3 id='impl' class='impl'><span class='in-band'><code>impl&lt;R:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>&gt; <a class="struct" href="../../rand/read/struct.ReadRng.html" title="struct rand::read::ReadRng">ReadRng</a>&lt;R&gt;</code><a href='#impl' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#38-45' title='goto source code'>[src]</a></span></h3>
  67. <div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><code>pub fn <a href='#method.new' class='fnname'>new</a>(r: R) -&gt; <a class="struct" href="../../rand/read/struct.ReadRng.html" title="struct rand::read::ReadRng">ReadRng</a>&lt;R&gt;</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#40-44' title='goto source code'>[src]</a></span></h4>
  68. <div class='docblock'><p>Create a new <code>ReadRng</code> from a <code>Read</code>.</p>
  69. </div></div>
  70. <h2 id='implementations' class='small-section-header'>
  71. Trait Implementations<a href='#implementations' class='anchor'></a>
  72. </h2>
  73. <h3 id='impl-Debug' class='impl'><span class='in-band'><code>impl&lt;R:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="../../rand/read/struct.ReadRng.html" title="struct rand::read::ReadRng">ReadRng</a>&lt;R&gt;</code><a href='#impl-Debug' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#33' title='goto source code'>[src]</a></span></h3>
  74. <div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&amp;self, __arg_0: &amp;mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -&gt; <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#33' title='goto source code'>[src]</a></span></h4>
  75. <div class='docblock'><p>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></p>
  76. </div></div><h3 id='impl-Rng' class='impl'><span class='in-band'><code>impl&lt;R:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/std/io/trait.Read.html" title="trait std::io::Read">Read</a>&gt; <a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a> for <a class="struct" href="../../rand/read/struct.ReadRng.html" title="struct rand::read::ReadRng">ReadRng</a>&lt;R&gt;</code><a href='#impl-Rng' class='anchor'></a></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#47-66' title='goto source code'>[src]</a></span></h3>
  77. <div class='impl-items'><h4 id='method.next_u32' class="method"><span id='next_u32.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#tymethod.next_u32' class='fnname'>next_u32</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#48-55' title='goto source code'>[src]</a></span></h4>
  78. <div class='docblock'><p>Return the next random u32. <a href="../../rand/trait.Rng.html#tymethod.next_u32">Read more</a></p>
  79. </div><h4 id='method.next_u64' class="method"><span id='next_u64.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.next_u64' class='fnname'>next_u64</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u64.html">u64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#56-61' title='goto source code'>[src]</a></span></h4>
  80. <div class='docblock'><p>Return the next random u64. <a href="../../rand/trait.Rng.html#method.next_u64">Read more</a></p>
  81. </div><h4 id='method.fill_bytes' class="method"><span id='fill_bytes.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.fill_bytes' class='fnname'>fill_bytes</a>(&amp;mut self, v: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;mut [</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u8.html">u8</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">]</a>)</code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/read.rs.html#62-65' title='goto source code'>[src]</a></span></h4>
  82. <div class='docblock'><p>Fill <code>dest</code> with random data. <a href="../../rand/trait.Rng.html#method.fill_bytes">Read more</a></p>
  83. </div><h4 id='method.next_f32' class="method"><span id='next_f32.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.next_f32' class='fnname'>next_f32</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f32.html">f32</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#383-389' title='goto source code'>[src]</a></span></h4>
  84. <div class='docblock'><p>Return the next random f32 selected from the half-open interval <code>[0, 1)</code>. <a href="../../rand/trait.Rng.html#method.next_f32">Read more</a></p>
  85. </div><h4 id='method.next_f64' class="method"><span id='next_f64.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.next_f64' class='fnname'>next_f64</a>(&amp;mut self) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.f64.html">f64</a></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#401-407' title='goto source code'>[src]</a></span></h4>
  86. <div class='docblock'><p>Return the next random f64 selected from the half-open interval <code>[0, 1)</code>. <a href="../../rand/trait.Rng.html#method.next_f64">Read more</a></p>
  87. </div><h4 id='method.gen' class="method"><span id='gen.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen' class='fnname'>gen</a>&lt;T:&nbsp;<a class="trait" href="../../rand/trait.Rand.html" title="trait rand::Rand">Rand</a>&gt;(&amp;mut self) -&gt; T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#473-475' title='goto source code'>[src]</a></span></h4>
  88. <div class='docblock'><p>Return a random value of a <code>Rand</code> type. <a href="../../rand/trait.Rng.html#method.gen">Read more</a></p>
  89. </div><h4 id='method.gen_iter' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../rand/struct.Generator.html" title="struct rand::Generator">Generator</a>&lt;'a, T, R&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../rand/struct.Generator.html" title="struct rand::Generator">Generator</a>&lt;'a, T, R&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;'a, T:&nbsp;<a class="trait" href="../../rand/trait.Rand.html" title="trait rand::Rand">Rand</a>, R:&nbsp;<a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../../rand/struct.Generator.html" title="struct rand::Generator">Generator</a>&lt;'a, T, R&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = T;</span></code></div></div><span id='gen_iter.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen_iter' class='fnname'>gen_iter</a>&lt;'a, T:&nbsp;<a class="trait" href="../../rand/trait.Rand.html" title="trait rand::Rand">Rand</a>&gt;(&amp;'a mut self) -&gt; <a class="struct" href="../../rand/struct.Generator.html" title="struct rand::Generator">Generator</a>&lt;'a, T, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#491-493' title='goto source code'>[src]</a></span></h4>
  90. <div class='docblock'><p>Return an iterator that will yield an infinite number of randomly generated items. <a href="../../rand/trait.Rng.html#method.gen_iter">Read more</a></p>
  91. </div><h4 id='method.gen_range' class="method"><span id='gen_range.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen_range' class='fnname'>gen_range</a>&lt;T:&nbsp;<a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.PartialOrd.html" title="trait core::cmp::PartialOrd">PartialOrd</a> + <a class="trait" href="../../rand/distributions/range/trait.SampleRange.html" title="trait rand::distributions::range::SampleRange">SampleRange</a>&gt;(&amp;mut self, low: T, high: T) -&gt; T <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#518-521' title='goto source code'>[src]</a></span></h4>
  92. <div class='docblock'><p>Generate a random value in the range [<code>low</code>, <code>high</code>). <a href="../../rand/trait.Rng.html#method.gen_range">Read more</a></p>
  93. </div><h4 id='method.gen_weighted_bool' class="method"><span id='gen_weighted_bool.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen_weighted_bool' class='fnname'>gen_weighted_bool</a>(&amp;mut self, n: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.u32.html">u32</a>) -&gt; <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a> <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#533-535' title='goto source code'>[src]</a></span></h4>
  94. <div class='docblock'><p>Return a bool with a 1 in n chance of true <a href="../../rand/trait.Rng.html#method.gen_weighted_bool">Read more</a></p>
  95. </div><h4 id='method.gen_ascii_chars' class="method"><div class="important-traits"><div class='tooltip'>ⓘ<span class='tooltiptext'>Important traits for <a class="struct" href="../../rand/struct.AsciiGenerator.html" title="struct rand::AsciiGenerator">AsciiGenerator</a>&lt;'a, R&gt;</span></div><div class="content hidden"><h3 class="important">Important traits for <a class="struct" href="../../rand/struct.AsciiGenerator.html" title="struct rand::AsciiGenerator">AsciiGenerator</a>&lt;'a, R&gt;</h3><code class="content"><span class="where fmt-newline">impl&lt;'a, R:&nbsp;<a class="trait" href="../../rand/trait.Rng.html" title="trait rand::Rng">Rng</a>&gt; <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html" title="trait core::iter::iterator::Iterator">Iterator</a> for <a class="struct" href="../../rand/struct.AsciiGenerator.html" title="struct rand::AsciiGenerator">AsciiGenerator</a>&lt;'a, R&gt;</span><span class="where fmt-newline"> type <a href='https://doc.rust-lang.org/nightly/core/iter/iterator/trait.Iterator.html#associatedtype.Item' class="type">Item</a> = <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.char.html">char</a>;</span></code></div></div><span id='gen_ascii_chars.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.gen_ascii_chars' class='fnname'>gen_ascii_chars</a>&lt;'a&gt;(&amp;'a mut self) -&gt; <a class="struct" href="../../rand/struct.AsciiGenerator.html" title="struct rand::AsciiGenerator">AsciiGenerator</a>&lt;'a, Self&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#547-549' title='goto source code'>[src]</a></span></h4>
  96. <div class='docblock'><p>Return an iterator of random characters from the set A-Z,a-z,0-9. <a href="../../rand/trait.Rng.html#method.gen_ascii_chars">Read more</a></p>
  97. </div><h4 id='method.choose' class="method"><span id='choose.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.choose' class='fnname'>choose</a>&lt;'a, T&gt;(&amp;mut self, values: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a [T]</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a </a>T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#565-571' title='goto source code'>[src]</a></span></h4>
  98. <div class='docblock'><p>Return a random element from <code>values</code>. <a href="../../rand/trait.Rng.html#method.choose">Read more</a></p>
  99. </div><h4 id='method.choose_mut' class="method"><span id='choose_mut.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.choose_mut' class='fnname'>choose_mut</a>&lt;'a, T&gt;(&amp;mut self, values: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;'a mut [T]</a>) -&gt; <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a>&lt;<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&amp;'a mut </a>T&gt; <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#576-583' title='goto source code'>[src]</a></span></h4>
  100. <div class='docblock'><p>Return a mutable pointer to a random element from <code>values</code>. <a href="../../rand/trait.Rng.html#method.choose_mut">Read more</a></p>
  101. </div><h4 id='method.shuffle' class="method"><span id='shuffle.v' class='invisible'><code>fn <a href='../../rand/trait.Rng.html#method.shuffle' class='fnname'>shuffle</a>&lt;T&gt;(&amp;mut self, values: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.slice.html">&amp;mut [T]</a>) <span class="where fmt-newline">where<br>&nbsp;&nbsp;&nbsp;&nbsp;Self: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,&nbsp;</span></code></span><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../../src/rand/lib.rs.html#602-610' title='goto source code'>[src]</a></span></h4>
  102. <div class='docblock'><p>Shuffle a mutable slice in place. <a href="../../rand/trait.Rng.html#method.shuffle">Read more</a></p>
  103. </div></div></section>
  104. <section id='search' class="content hidden"></section>
  105. <section class="footer"></section>
  106. <aside id="help" class="hidden">
  107. <div>
  108. <h1 class="hidden">Help</h1>
  109. <div class="shortcuts">
  110. <h2>Keyboard Shortcuts</h2>
  111. <dl>
  112. <dt><kbd>?</kbd></dt>
  113. <dd>Show this help dialog</dd>
  114. <dt><kbd>S</kbd></dt>
  115. <dd>Focus the search field</dd>
  116. <dt><kbd>↑</kbd></dt>
  117. <dd>Move up in search results</dd>
  118. <dt><kbd>↓</kbd></dt>
  119. <dd>Move down in search results</dd>
  120. <dt><kbd>↹</kbd></dt>
  121. <dd>Switch tab</dd>
  122. <dt><kbd>&#9166;</kbd></dt>
  123. <dd>Go to active search result</dd>
  124. <dt><kbd>+</kbd></dt>
  125. <dd>Expand all sections</dd>
  126. <dt><kbd>-</kbd></dt>
  127. <dd>Collapse all sections</dd>
  128. </dl>
  129. </div>
  130. <div class="infos">
  131. <h2>Search Tricks</h2>
  132. <p>
  133. Prefix searches with a type followed by a colon (e.g.
  134. <code>fn:</code>) to restrict the search to a given type.
  135. </p>
  136. <p>
  137. Accepted types are: <code>fn</code>, <code>mod</code>,
  138. <code>struct</code>, <code>enum</code>,
  139. <code>trait</code>, <code>type</code>, <code>macro</code>,
  140. and <code>const</code>.
  141. </p>
  142. <p>
  143. Search functions by type signature (e.g.
  144. <code>vec -> usize</code> or <code>* -> vec</code>)
  145. </p>
  146. </div>
  147. </div>
  148. </aside>
  149. <script>
  150. window.rootPath = "../../";
  151. window.currentCrate = "rand";
  152. </script>
  153. <script src="../../main.js"></script>
  154. <script defer src="../../search-index.js"></script>
  155. </body>
  156. </html>