mirror of
https://github.com/neogeek23/rusty_snek_gaem.git
synced 2026-02-04 11:08:40 +00:00
44 lines
12 KiB
HTML
44 lines
12 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 `Scope` struct in crate `rayon`."><meta name="keywords" content="rust, rustlang, rust-lang, Scope"><title>rayon::Scope - 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 Scope</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#methods">Methods</a><div class="sidebar-links"><a href="#method.spawn">spawn</a></div><a class="sidebar-title" href="#implementations">Trait Implementations</a><div class="sidebar-links"><a href="#impl-Debug">Debug</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: 'Scope', 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=''>Scope</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/scope/mod.rs.html#27-48' title='goto source code'>[src]</a></span></h1><div class="docblock type-decl"><pre class='rust struct'>pub struct Scope<'scope> { /* fields omitted */ }</pre></div><div class='docblock'><p>Represents a fork-join scope which can be used to spawn any number of tasks. See <a href="fn.scope.html"><code>scope()</code></a> for more information.</p>
|
||
</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<'scope> <a class="struct" href="../rayon/struct.Scope.html" title="struct rayon::Scope">Scope</a><'scope></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/scope/mod.rs.html#278-406' title='goto source code'>[src]</a></span></td></tr></tbody></table></h3><div class='impl-items'><h4 id='method.spawn' class="method"><span id='spawn.v' class='invisible'><table class='table-display'><tbody><tr><td><code>pub fn <a href='#method.spawn' class='fnname'>spawn</a><BODY>(&self, body: BODY) <span class="where fmt-newline">where<br> BODY: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&<a class="struct" href="../rayon/struct.Scope.html" title="struct rayon::Scope">Scope</a><'scope>) + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'scope, </span></code></span></td><td><span class='out-of-band'><div class='ghost'></div><a class='srclink' href='../src/rayon_core/scope/mod.rs.html#331-344' title='goto source code'>[src]</a></td></tr></tbody></table></span></h4><div class='docblock'><p>Spawns a job into the fork-join scope <code>self</code>. This job will
|
||
execute sometime before the fork-join scope completes. The
|
||
job is specified as a closure, and this closure receives its
|
||
own reference to the scope <code>self</code> as argument. This can be
|
||
used to inject new jobs into <code>self</code>.</p>
|
||
<h1 id="returns" class="section-header"><a href="#returns">Returns</a></h1>
|
||
<p>Nothing. The spawned closures cannot pass back values to the
|
||
caller directly, though they can write to local variables on
|
||
the stack (if those variables outlive the scope) or
|
||
communicate through shared channels.</p>
|
||
<p>(The intention is to eventualy integrate with Rust futures to
|
||
support spawns of functions that compute a value.)</p>
|
||
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
<pre class="rust rust-example-rendered">
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">value_a</span> <span class="op">=</span> <span class="prelude-val">None</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">value_b</span> <span class="op">=</span> <span class="prelude-val">None</span>;
|
||
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">value_c</span> <span class="op">=</span> <span class="prelude-val">None</span>;
|
||
<span class="ident">rayon</span>::<span class="ident">scope</span>(<span class="op">|</span><span class="ident">s</span><span class="op">|</span> {
|
||
<span class="ident">s</span>.<span class="ident">spawn</span>(<span class="op">|</span><span class="ident">s1</span><span class="op">|</span> {
|
||
<span class="comment">// ^ this is the same scope as `s`; this handle `s1`</span>
|
||
<span class="comment">// is intended for use by the spawned task,</span>
|
||
<span class="comment">// since scope handles cannot cross thread boundaries.</span>
|
||
|
||
<span class="ident">value_a</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">22</span>);
|
||
|
||
<span class="comment">// the scope `s` will not end until all these tasks are done</span>
|
||
<span class="ident">s1</span>.<span class="ident">spawn</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> {
|
||
<span class="ident">value_b</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">44</span>);
|
||
});
|
||
});
|
||
|
||
<span class="ident">s</span>.<span class="ident">spawn</span>(<span class="op">|</span><span class="kw">_</span><span class="op">|</span> {
|
||
<span class="ident">value_c</span> <span class="op">=</span> <span class="prelude-val">Some</span>(<span class="number">66</span>);
|
||
});
|
||
});
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">value_a</span>, <span class="prelude-val">Some</span>(<span class="number">22</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">value_b</span>, <span class="prelude-val">Some</span>(<span class="number">44</span>));
|
||
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">value_c</span>, <span class="prelude-val">Some</span>(<span class="number">66</span>));</pre>
|
||
<h1 id="see-also" class="section-header"><a href="#see-also">See also</a></h1>
|
||
<p>The <a href="fn.scope.html"><code>scope</code> function</a> has more extensive documentation about
|
||
task spawning.</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<'scope> <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.Scope.html" title="struct rayon::Scope">Scope</a><'scope></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/scope/mod.rs.html#408-417' 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, fmt: &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/scope/mod.rs.html#409-416' 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></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<'scope> <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.Scope.html" title="struct rayon::Scope">Scope</a><'scope></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<'scope> <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.Scope.html" title="struct rayon::Scope">Scope</a><'scope></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> |