38 lines
6.2 KiB
HTML
38 lines
6.2 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="Puts the task into the Rayon thread pool’s job queue 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 `'static` lifetime. If you want to spawn a task that references stack data, use the `scope()` function to create a scope."><title>spawn in rayon - Rust</title><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">spawn</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../rayon/index.html">rayon</a><span class="version">1.11.0</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">spawn</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#panic-handling" title="Panic handling">Panic handling</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2 class="in-crate"><a href="index.html">In crate rayon</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="index.html">rayon</a></div><h1>Function <span class="fn">spawn</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../src/rayon_core/spawn/mod.rs.html#58-60">Source</a> </span></div><pre class="rust item-decl"><code>pub fn spawn<F>(func: F)<div class="where">where
|
||
F: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Puts the task into the Rayon thread pool’s job queue 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.html" title="fn rayon::scope">the <code>scope()</code>
|
||
function</a> to create a scope.</p>
|
||
<p>Since tasks spawned with this function cannot hold references into
|
||
the enclosing stack frame, you almost certainly want to use a
|
||
<code>move</code> closure as their argument (otherwise, the closure will
|
||
typically hold references to any variables from the enclosing
|
||
function that you happen to use).</p>
|
||
<p>This API assumes that the closure is executed purely for its
|
||
side-effects (i.e., it might send messages, modify data protected
|
||
by a mutex, or some such thing).</p>
|
||
<p>There is no guaranteed order of execution for spawns, given that
|
||
other threads may steal tasks at any time. However, they are
|
||
generally prioritized in a LIFO order on the thread from which
|
||
they were spawned. Other threads always steal from the other end of
|
||
the deque, like FIFO order. The idea is that “recent” tasks are
|
||
most likely to be fresh in the local CPU’s cache, while other
|
||
threads can steal older “stale” tasks. For an alternate approach,
|
||
consider <a href="fn.spawn_fifo.html" title="fn rayon::spawn_fifo"><code>spawn_fifo()</code></a> instead.</p>
|
||
<h2 id="panic-handling"><a class="doc-anchor" href="#panic-handling">§</a>Panic handling</h2>
|
||
<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" title="method rayon::ThreadPoolBuilder::panic_handler"><code>ThreadPoolBuilder::panic_handler()</code></a> for more
|
||
details.</p>
|
||
<h2 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h2>
|
||
<p>This code creates a Rayon task that increments a global counter.</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>std::sync::atomic::{AtomicUsize, Ordering, ATOMIC_USIZE_INIT};
|
||
|
||
<span class="kw">static </span>GLOBAL_COUNTER: AtomicUsize = ATOMIC_USIZE_INIT;
|
||
|
||
rayon::spawn(<span class="kw">move </span>|| {
|
||
GLOBAL_COUNTER.fetch_add(<span class="number">1</span>, Ordering::SeqCst);
|
||
});</code></pre></div></div></details></section></div></main></body></html> |