mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 19:18:44 +00:00
97 lines
24 KiB
HTML
97 lines
24 KiB
HTML
<!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="API documentation for the Rust `ThreadPoolBuilder` struct in crate `rayon`."><meta name="keywords" content="rust, rustlang, rust-lang, ThreadPoolBuilder"><title>rayon::ThreadPoolBuilder - Rust</title><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="../dark.css"><link rel="stylesheet" type="text/css" href="../light.css" id="themeStyle"><script src="../storage.js"></script></head><body class="rustdoc struct"><!--[if lte IE 8]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="sidebar"><div class="sidebar-menu">☰</div><p class='location'>Struct ThreadPoolBuilder</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><a href="#method.build">build</a><a href="#method.build_global">build_global</a><a href="#method.thread_name">thread_name</a><a href="#method.num_threads">num_threads</a><a href="#method.panic_handler">panic_handler</a><a href="#method.stack_size">stack_size</a><a href="#method.breadth_first">breadth_first</a><a href="#method.start_handler">start_handler</a><a href="#method.exit_handler">exit_handler</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</a><a href="#impl-Default">Default</a></div><a class="sidebar-title" href="#synthetic-implementations">Auto Trait Implementations</a><div class="sidebar-links"><a href="#impl-Send">!Send</a><a href="#impl-Sync">!Sync</a></div></div><p class='location'><a href='index.html'>rayon</a></p><script>window.sidebarCurrent = {name: 'ThreadPoolBuilder', ty: 'struct', relpath: ''};</script><script defer src="sidebar-items.js"></script></div></nav><div class="theme-picker"><button id="theme-picker" aria-label="Pick another theme!"><img src="../brush.svg" width="18" alt="Pick another theme!"></button><div id="theme-choices"></div></div><script src="../theme.js"></script><nav class="sub"><form class="search-form js-only"><div class="search-container"><input class="search-input" name="search" autocomplete="off" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><a id="settings-menu" href="../settings.html"><img src="../wheel.svg" width="18" alt="Change settings"></a></div></form></nav><section id="main" class="content"><h1 class='fqn'><span class='in-band'>Struct <a href='index.html'>rayon</a>::<wbr><a class="struct" href=''>ThreadPoolBuilder</a></span><span class='out-of-band'><span id='render-detail'><a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class='inner'>−</span>]</a></span><a class='srclink' href='../src/rayon_core/lib.rs.html#122-148' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct ThreadPoolBuilder { /* fields omitted */ }</pre></div><div class='docblock'><p>Used to create a new <a href="struct.ThreadPool.html"><code>ThreadPool</code></a> or to configure the global rayon thread pool.</p>
|
||
<h2 id="creating-a-threadpool" class="section-header"><a href="#creating-a-threadpool">Creating a ThreadPool</a></h2>
|
||
<p>The following creates a thread pool with 22 threads.</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="ident">pool</span> <span class="op">=</span> <span class="ident">rayon</span>::<span class="ident">ThreadPoolBuilder</span>::<span class="ident">new</span>().<span class="ident">num_threads</span>(<span class="number">22</span>).<span class="ident">build</span>().<span class="ident">unwrap</span>();</pre>
|
||
<p>To instead configure the global thread pool, use <a href="struct.ThreadPoolBuilder.html#method.build_global"><code>build_global()</code></a>:</p>
|
||
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="ident">rayon</span>::<span class="ident">ThreadPoolBuilder</span>::<span class="ident">new</span>().<span class="ident">num_threads</span>(<span class="number">22</span>).<span class="ident">build_global</span>().<span class="ident">unwrap</span>();</pre>
|
||
</div><h2 id='methods' class='small-section-header'>Methods<a href='#methods' class='anchor'></a></h2><h3 id='impl' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code><a href='#impl' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#173-372' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.new' class="method"><span id='new.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.new' class='fnname'>new</a>() -> <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#175-177' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Creates and returns a valid rayon thread pool builder, but does not initialize it.</p>
|
||
</div><h4 id='method.build' class="method"><span id='build.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build' class='fnname'>build</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="struct" href="../rayon/struct.ThreadPool.html" title="struct rayon::ThreadPool">ThreadPool</a>, <a class="struct" href="../rayon/struct.ThreadPoolBuildError.html" title="struct rayon::ThreadPoolBuildError">ThreadPoolBuildError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#180-182' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Create a new <code>ThreadPool</code> initialized using this configuration.</p>
|
||
</div><h4 id='method.build_global' class="method"><span id='build_global.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.build_global' class='fnname'>build_global</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="../rayon/struct.ThreadPoolBuildError.html" title="struct rayon::ThreadPoolBuildError">ThreadPoolBuildError</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#201-205' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Initializes the global thread pool. This initialization is
|
||
<strong>optional</strong>. If you do not call this function, the thread pool
|
||
will be automatically initialized with the default
|
||
configuration. Calling <code>build_global</code> is not recommended, except
|
||
in two scenarios:</p>
|
||
<ul>
|
||
<li>You wish to change the default configuration.</li>
|
||
<li>You are running a benchmark, in which case initializing may
|
||
yield slightly more consistent results, since the worker threads
|
||
will already be ready to go even in the first iteration. But
|
||
this cost is minimal.</li>
|
||
</ul>
|
||
<p>Initialization of the global thread pool happens exactly
|
||
once. Once started, the configuration cannot be
|
||
changed. Therefore, if you call <code>build_global</code> a second time, it
|
||
will return an error. An <code>Ok</code> result indicates that this
|
||
is the first initialization of the thread pool.</p>
|
||
</div><h4 id='method.thread_name' class="method"><span id='thread_name.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.thread_name' class='fnname'>thread_name</a><F>(self, closure: F) -> <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a> <span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnMut.html" title="trait core::ops::function::FnMut">FnMut</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/string/struct.String.html" title="struct alloc::string::String">String</a> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#234-238' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set a closure which takes a thread index and returns
|
||
the thread's name.</p>
|
||
</div><h4 id='method.num_threads' class="method"><span id='num_threads.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.num_threads' class='fnname'>num_threads</a>(self, num_threads: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#266-269' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the number of threads to be used in the rayon threadpool.</p>
|
||
<p>If you specify a non-zero number of threads using this
|
||
function, then the resulting thread-pools are guaranteed to
|
||
start at most this number of threads.</p>
|
||
<p>If <code>num_threads</code> is 0, or you do not call this function, then
|
||
the Rayon runtime will select the number of threads
|
||
automatically. At present, this is based on the
|
||
<code>RAYON_NUM_THREADS</code> environment variable (if set),
|
||
or the number of logical CPUs (otherwise).
|
||
In the future, however, the default behavior may
|
||
change to dynamically add or remove threads as needed.</p>
|
||
<p><strong>Future compatibility warning:</strong> Given the default behavior
|
||
may change in the future, if you wish to rely on a fixed
|
||
number of threads, you should use this function to specify
|
||
that number. To reproduce the current default behavior, you
|
||
may wish to use the <a href="https://crates.io/crates/num_cpus"><code>num_cpus</code>
|
||
crate</a> to query the number
|
||
of CPUs dynamically.</p>
|
||
<p><strong>Old environment variable:</strong> <code>RAYON_NUM_THREADS</code> is a one-to-one
|
||
replacement of the now deprecated <code>RAYON_RS_NUM_CPUS</code> environment
|
||
variable. If both variables are specified, <code>RAYON_NUM_THREADS</code> will
|
||
be prefered.</p>
|
||
</div><h4 id='method.panic_handler' class="method"><span id='panic_handler.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.panic_handler' class='fnname'>panic_handler</a><H>(self, panic_handler: H) -> <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a> <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="struct" href="https://doc.rust-lang.org/nightly/alloc/boxed/struct.Box.html" title="struct alloc::boxed::Box">Box</a><<a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> + 'static + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>>) + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#290-295' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Normally, whenever Rayon catches a panic, it tries to
|
||
propagate it to someplace sensible, to try and reflect the
|
||
semantics of sequential execution. But in some cases,
|
||
particularly with the <code>spawn()</code> APIs, there is no
|
||
obvious place where we should propagate the panic to.
|
||
In that case, this panic handler is invoked.</p>
|
||
<p>If no panic handler is set, the default is to abort the
|
||
process, under the principle that panics should not go
|
||
unobserved.</p>
|
||
<p>If the panic handler itself panics, this will abort the
|
||
process. To prevent this, wrap the body of your panic handler
|
||
in a call to <code>std::panic::catch_unwind()</code>.</p>
|
||
</div><h4 id='method.stack_size' class="method"><span id='stack_size.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.stack_size' class='fnname'>stack_size</a>(self, stack_size: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#303-306' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set the stack size of the worker threads</p>
|
||
</div><h4 id='method.breadth_first' class="method"><span id='breadth_first.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.breadth_first' class='fnname'>breadth_first</a>(self) -> <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#328-331' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Suggest to worker threads that they execute spawned jobs in a
|
||
"breadth-first" fashion. Typically, when a worker thread is
|
||
idle or blocked, it will attempt to execute the job from the
|
||
<em>top</em> of its local deque of work (i.e., the job most recently
|
||
spawned). If this flag is set to true, however, workers will
|
||
prefer to execute in a <em>breadth-first</em> fashion -- that is,
|
||
they will search for jobs at the <em>bottom</em> of their local
|
||
deque. (At present, workers <em>always</em> steal from the bottom of
|
||
other worker's deques, regardless of the setting of this
|
||
flag.)</p>
|
||
<p>If you think of the tasks as a tree, where a parent task
|
||
spawns its children in the tree, then this flag loosely
|
||
corresponds to doing a breadth-first traversal of the tree,
|
||
whereas the default would be to do a depth-first traversal.</p>
|
||
<p><strong>Note that this is an "execution hint".</strong> Rayon's task
|
||
execution is highly dynamic and the precise order in which
|
||
independent tasks are executed is not intended to be
|
||
guaranteed.</p>
|
||
</div><h4 id='method.start_handler' class="method"><span id='start_handler.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.start_handler' class='fnname'>start_handler</a><H>(self, start_handler: H) -> <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a> <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#348-353' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set a callback to be invoked on thread start.</p>
|
||
<p>The closure is passed the index of the thread on which it is invoked.
|
||
Note that this same closure may be invoked multiple times in parallel.
|
||
If this closure panics, the panic will be passed to the panic handler.
|
||
If that handler returns, then startup will continue normally.</p>
|
||
</div><h4 id='method.exit_handler' class="method"><span id='exit_handler.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.exit_handler' class='fnname'>exit_handler</a><H>(self, exit_handler: H) -> <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a> <span class="where fmt-newline">where<br> H: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.Fn.html" title="trait core::ops::function::Fn">Fn</a>(<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> + 'static, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#366-371' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Set a callback to be invoked on thread exit.</p>
|
||
<p>The closure is passed the index of the thread on which it is invoked.
|
||
Note that this same closure may be invoked multiple times in parallel.
|
||
If this closure panics, the panic will be passed to the panic handler.
|
||
If that handler returns, then the thread will exit normally.</p>
|
||
</div></div><h2 id='implementations' class='small-section-header'>Trait Implementations<a href='#implementations' class='anchor'></a></h2><div id='implementations-list'><h3 id='impl-Debug' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <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="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code><a href='#impl-Debug' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#472-502' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.fmt' class="method"><span id='fmt.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt' class='fnname'>fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.unit.html">()</a>, <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Error.html" title="struct core::fmt::Error">Error</a>></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#473-501' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><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>
|
||
</div></div><h3 id='impl-Default' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code><a href='#impl-Default' class='anchor'></a></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#121' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.default' class="method"><span id='default.v' class='invisible'><table class='table-display'><tbody><tr><td><code>fn <a href='https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default' class='fnname'>default</a>() -> <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/lib.rs.html#121' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Returns the "default value" for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></p>
|
||
</div></div></div><h2 id='synthetic-implementations' class='small-section-header'>Auto Trait Implementations<a href='#synthetic-implementations' class='anchor'></a></h2><div id='synthetic-implementations-list'><h3 id='impl-Send' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code><a href='#impl-Send' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div><h3 id='impl-Sync' class='impl'><span class='in-band'><table class='table-display'><tbody><tr><td><code>impl !<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="../rayon/struct.ThreadPoolBuilder.html" title="struct rayon::ThreadPoolBuilder">ThreadPoolBuilder</a></code><a href='#impl-Sync' class='anchor'></a></span></td><td><span class='out-of-band'></span></td></tr></tbody></table></h3><div class='impl-items'></div></div></section><section id="search" class="content hidden"></section><section class="footer"></section><aside id="help" class="hidden"><div><h1 class="hidden">Help</h1><div class="shortcuts"><h2>Keyboard Shortcuts</h2><dl><dt><kbd>?</kbd></dt><dd>Show this help dialog</dd><dt><kbd>S</kbd></dt><dd>Focus the search field</dd><dt><kbd>↑</kbd></dt><dd>Move up in search results</dd><dt><kbd>↓</kbd></dt><dd>Move down in search results</dd><dt><kbd>↹</kbd></dt><dd>Switch tab</dd><dt><kbd>⏎</kbd></dt><dd>Go to active search result</dd><dt><kbd>+</kbd></dt><dd>Expand all sections</dd><dt><kbd>-</kbd></dt><dd>Collapse all sections</dd></dl></div><div class="infos"><h2>Search Tricks</h2><p>Prefix searches with a type followed by a colon (e.g. <code>fn:</code>) to restrict the search to a given type.</p><p>Accepted types are: <code>fn</code>, <code>mod</code>, <code>struct</code>, <code>enum</code>, <code>trait</code>, <code>type</code>, <code>macro</code>, and <code>const</code>.</p><p>Search functions by type signature (e.g. <code>vec -> usize</code> or <code>* -> vec</code>)</p><p>Search multiple things at once by splitting your query with comma (e.g. <code>str,u8</code> or <code>String,struct:Vec,test</code>)</p></div></div></aside><script>window.rootPath = "../";window.currentCrate = "rayon";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html> |