|
|
<!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="Creates a “fork-join” scope `s` with FIFO order, and invokes the closure with a reference to `s`. This closure can then spawn asynchronous tasks into `s`. Those tasks may run asynchronously with respect to the closure; they may themselves spawn additional tasks into `s`. When the closure returns, it will block until all tasks that have been spawned into `s` complete."><title>scope_fifo in rayon - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../" data-static-root-path="../static.files/" data-current-crate="rayon" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-2c020d218678b618.svg"></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]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../rayon/index.html">rayon</a><span class="version">1.10.0</span></h2></div><div class="sidebar-elems"></div></nav><div class="sidebar-resizer"></div>
|
|
|
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../rayon/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="index.html">rayon</a>::<wbr><a class="fn" href="#">scope_fifo</a><button id="copy-path" title="Copy item path to clipboard"><img src="../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../src/rayon_core/scope/mod.rs.html#375-378">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn scope_fifo<'scope, OP, R>(op: OP) -> R<div class="where">where
|
|
|
OP: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>(&<a class="struct" href="struct.ScopeFifo.html" title="struct rayon::ScopeFifo">ScopeFifo</a><'scope>) -> R + <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,
|
|
|
R: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a “fork-join” scope <code>s</code> with FIFO order, and invokes the
|
|
|
closure with a reference to <code>s</code>. This closure can then spawn
|
|
|
asynchronous tasks into <code>s</code>. Those tasks may run asynchronously with
|
|
|
respect to the closure; they may themselves spawn additional tasks
|
|
|
into <code>s</code>. When the closure returns, it will block until all tasks
|
|
|
that have been spawned into <code>s</code> complete.</p>
|
|
|
<h2 id="task-execution"><a href="#task-execution">Task execution</a></h2>
|
|
|
<p>Tasks in a <code>scope_fifo()</code> run similarly to <a href="fn.scope.html"><code>scope()</code></a>, but there’s a
|
|
|
difference in the order of execution. Consider a similar example:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="comment">// point start
|
|
|
</span>rayon::scope_fifo(|s| {
|
|
|
s.spawn_fifo(|s| { <span class="comment">// task s.1
|
|
|
</span>s.spawn_fifo(|s| { <span class="comment">// task s.1.1
|
|
|
</span>rayon::scope_fifo(|t| {
|
|
|
t.spawn_fifo(|<span class="kw">_</span>| ()); <span class="comment">// task t.1
|
|
|
</span>t.spawn_fifo(|<span class="kw">_</span>| ()); <span class="comment">// task t.2
|
|
|
</span>});
|
|
|
});
|
|
|
});
|
|
|
s.spawn_fifo(|s| { <span class="comment">// task s.2
|
|
|
</span>});
|
|
|
<span class="comment">// point mid
|
|
|
</span>});
|
|
|
<span class="comment">// point end</span></code></pre></div>
|
|
|
<p>The various tasks that are run will execute roughly like so:</p>
|
|
|
<div class="example-wrap"><pre class="language-notrust"><code>| (start)
|
|
|
|
|
|
|
| (FIFO scope `s` created)
|
|
|
+--------------------+ (task s.1)
|
|
|
+-------+ (task s.2) |
|
|
|
| | +---+ (task s.1.1)
|
|
|
| | | |
|
|
|
| | | | (FIFO scope `t` created)
|
|
|
| | | +----------------+ (task t.1)
|
|
|
| | | +---+ (task t.2) |
|
|
|
| (mid) | | | | |
|
|
|
: | | + <-+------------+ (scope `t` ends)
|
|
|
: | | |
|
|
|
|<------+------------+---+ (scope `s` ends)
|
|
|
|
|
|
|
| (end)
|
|
|
</code></pre></div>
|
|
|
<p>Under <code>scope_fifo()</code>, the spawns are prioritized in a FIFO order on
|
|
|
the thread from which they were spawned, as opposed to <code>scope()</code>’s
|
|
|
LIFO. So in this example, we can expect <code>s.1</code> to execute before
|
|
|
<code>s.2</code>, and <code>t.1</code> before <code>t.2</code>. Other threads also steal tasks in
|
|
|
FIFO order, as usual. Overall, this has roughly the same order as
|
|
|
the now-deprecated <a href="struct.ThreadPoolBuilder.html#method.breadth_first"><code>breadth_first</code></a> option, except the effect is
|
|
|
isolated to a particular scope. If spawns are intermingled from any
|
|
|
combination of <code>scope()</code> and <code>scope_fifo()</code>, or from different
|
|
|
threads, their order is only specified with respect to spawns in the
|
|
|
same scope and thread.</p>
|
|
|
<p>For more details on this design, see Rayon <a href="https://github.com/rayon-rs/rfcs/blob/master/accepted/rfc0001-scope-scheduling.md">RFC #1</a>.</p>
|
|
|
<h2 id="panics"><a href="#panics">Panics</a></h2>
|
|
|
<p>If a panic occurs, either in the closure given to <code>scope_fifo()</code> or
|
|
|
in any of the spawned jobs, that panic will be propagated and the
|
|
|
call to <code>scope_fifo()</code> will panic. If multiple panics occurs, it is
|
|
|
non-deterministic which of their panic values will propagate.
|
|
|
Regardless, once a task is spawned using <code>scope.spawn_fifo()</code>, it
|
|
|
will execute, even if the spawning task should later panic.
|
|
|
<code>scope_fifo()</code> returns once all spawned jobs have completed, and any
|
|
|
panics are propagated at that point.</p>
|
|
|
</div></details></section></div></main></body></html> |