|
|
|
|
|
<!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 `spawn_fifo` fn in crate `rayon_core`."><meta name="keywords" content="rust, rustlang, rust-lang, spawn_fifo"><title>rayon_core::spawn_fifo - 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><noscript><link rel="stylesheet" href="../noscript.css"></noscript><link rel="shortcut icon" href="../favicon.ico"><style type="text/css">#crate-search{background-image:url("../down-arrow.svg");}</style></head><body class="rustdoc fn"><!--[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><a href='../rayon_core/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><div class="sidebar-elems"><p class='location'><a href='index.html'>rayon_core</a></p><script>window.sidebarCurrent = {name: 'spawn_fifo', ty: 'fn', 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"><div><select id="crate-search"><option value="All crates">All crates</option></select><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"></div><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='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/spawn/mod.rs.html#136-142' title='goto source code'>[src]</a></span><span class='in-band'>Function <a href='index.html'>rayon_core</a>::<wbr><a class="fn" href=''>spawn_fifo</a></span></h1><pre class='rust fn'>pub fn spawn_fifo<F>(func: F) <span class="where fmt-newline">where<br> F: <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="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static, </span></pre><div class='docblock'><p>Fires off a task into the Rayon threadpool in the "static" or
|
|
|
|
|
|
"global" scope. Just like a standard thread, this task is not
|
|
|
|
|
|
tied to the current stack frame, and hence it cannot hold any
|
|
|
|
|
|
references other than those with <code>'static</code> lifetime. If you want
|
|
|
|
|
|
to spawn a task that references stack data, use <a href="fn.scope_fifo.html">the <code>scope_fifo()</code>
|
|
|
|
|
|
function</a> to create a scope.</p>
|
|
|
|
|
|
<p>The behavior is essentially the same as <a href="fn.spawn.html">the <code>spawn</code>
|
|
|
|
|
|
function</a>, except that calls from the same thread
|
|
|
|
|
|
will be prioritized in FIFO order. This is similar to the now-
|
|
|
|
|
|
deprecated <a href="struct.ThreadPoolBuilder.html#method.breadth_first"><code>breadth_first</code></a> option, except the effect is isolated
|
|
|
|
|
|
to relative <code>spawn_fifo</code> calls, not all threadpool tasks.</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>
|
|
|
|
|
|
<h1 id="panic-handling" class="section-header"><a href="#panic-handling">Panic handling</a></h1>
|
|
|
|
|
|
<p>If this closure should panic, the resulting panic will be
|
|
|
|
|
|
propagated to the panic handler registered in the <code>ThreadPoolBuilder</code>,
|
|
|
|
|
|
if any. See <a href="struct.ThreadPoolBuilder.html#method.panic_handler"><code>ThreadPoolBuilder::panic_handler()</code></a> for more
|
|
|
|
|
|
details.</p>
|
|
|
|
|
|
</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_core";</script><script src="../aliases.js"></script><script src="../main.js"></script><script defer src="../search-index.js"></script></body></html>
|
