|
|
<!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 `rayon` crate."><meta name="keywords" content="rust, rustlang, rust-lang, rayon"><title>rayon - 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 mod"><!--[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/index.html'><div class='logo-container'><img src='../rust-logo.png' alt='logo'></div></a><p class='location'>Crate rayon</p><div class="sidebar-elems"><a id='all-types' href='all.html'><p>See all rayon's items</p></a><div class="block items"><ul><li><a href="#modules">Modules</a></li><li><a href="#structs">Structs</a></li><li><a href="#functions">Functions</a></li></ul></div><p class='location'></p><script>window.sidebarCurrent = {name: 'rayon', ty: 'mod', relpath: '../'};</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/lib.rs.html#1-129' title='goto source code'>[src]</a></span><span class='in-band'>Crate <a class="mod" href=''>rayon</a></span></h1><div class='docblock'><p>Data-parallelism library that makes it easy to convert sequential
|
|
|
computations into parallel</p>
|
|
|
<p>Rayon is lightweight and convenient for introducing parallelism into existing
|
|
|
code. It guarantees data-race free executions and takes advantage of
|
|
|
parallelism when sensible, based on work-load at runtime.</p>
|
|
|
<h1 id="how-to-use-rayon" class="section-header"><a href="#how-to-use-rayon">How to use Rayon</a></h1>
|
|
|
<p>There are two ways to use Rayon:</p>
|
|
|
<ul>
|
|
|
<li><strong>High-level parallel constructs</strong> are the simplest way to use Rayon and also
|
|
|
typically the most efficient.
|
|
|
<ul>
|
|
|
<li><a href="iter/index.html">Parallel iterators</a> make it easy to convert a sequential iterator to
|
|
|
execute in parallel.</li>
|
|
|
<li>The <a href="slice/trait.ParallelSliceMut.html#method.par_sort"><code>par_sort</code></a> method sorts <code>&mut [T]</code> slices (or vectors) in parallel.</li>
|
|
|
<li><a href="iter/trait.ParallelExtend.html#tymethod.par_extend"><code>par_extend</code></a> can be used to efficiently grow collections with items produced
|
|
|
by a parallel iterator.</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
<li><strong>Custom tasks</strong> let you divide your work into parallel tasks yourself.
|
|
|
<ul>
|
|
|
<li><a href="fn.join.html"><code>join</code></a> is used to subdivide a task into two pieces.</li>
|
|
|
<li><a href="fn.scope.html"><code>scope</code></a> creates a scope within which you can create any number of parallel tasks.</li>
|
|
|
<li><a href="struct.ThreadPoolBuilder.html"><code>ThreadPoolBuilder</code></a> can be used to create your own thread pools or customize
|
|
|
the global one.</li>
|
|
|
</ul>
|
|
|
</li>
|
|
|
</ul>
|
|
|
<h1 id="basic-usage-and-the-rayon-prelude" class="section-header"><a href="#basic-usage-and-the-rayon-prelude">Basic usage and the Rayon prelude</a></h1>
|
|
|
<p>First, you will need to add <code>rayon</code> to your <code>Cargo.toml</code> and put
|
|
|
<code>extern crate rayon</code> in your main file (<code>lib.rs</code>, <code>main.rs</code>).</p>
|
|
|
<p>Next, to use parallel iterators or the other high-level methods,
|
|
|
you need to import several traits. Those traits are bundled into
|
|
|
the module <a href="prelude/index.html"><code>rayon::prelude</code></a>. It is recommended that you import
|
|
|
all of these traits at once by adding <code>use rayon::prelude::*</code> at
|
|
|
the top of each module that uses Rayon methods.</p>
|
|
|
<p>These traits give you access to the <code>par_iter</code> method which provides
|
|
|
parallel implementations of many iterative functions such as <a href="iter/trait.ParallelIterator.html#method.map"><code>map</code></a>,
|
|
|
<a href="iter/trait.ParallelIterator.html#method.for_each"><code>for_each</code></a>, <a href="iter/trait.ParallelIterator.html#method.filter"><code>filter</code></a>, <a href="iter/trait.ParallelIterator.html#method.fold"><code>fold</code></a>, and <a href="iter/trait.ParallelIterator.html#provided-methods">more</a>.</p>
|
|
|
<h1 id="crate-layout" class="section-header"><a href="#crate-layout">Crate Layout</a></h1>
|
|
|
<p>Rayon extends many of the types found in the standard library with
|
|
|
parallel iterator implementations. The modules in the <code>rayon</code>
|
|
|
crate mirror <a href="https://doc.rust-lang.org/std/"><code>std</code></a> itself: so, e.g., the <code>option</code> module in
|
|
|
Rayon contains parallel iterators for the <code>Option</code> type, which is
|
|
|
found in <a href="https://doc.rust-lang.org/std/option/index.html">the <code>option</code> module of <code>std</code></a>. Similarly, the
|
|
|
<code>collections</code> module in Rayon offers parallel iterator types for
|
|
|
<a href="https://doc.rust-lang.org/std/collections/index.html">the <code>collections</code> from <code>std</code></a>. You will rarely need to access
|
|
|
these submodules unless you need to name iterator types
|
|
|
explicitly.</p>
|
|
|
<h1 id="other-questions" class="section-header"><a href="#other-questions">Other questions?</a></h1>
|
|
|
<p>See <a href="https://github.com/rayon-rs/rayon/blob/master/FAQ.md">the Rayon FAQ</a>.</p>
|
|
|
</div><h2 id='modules' class='section-header'><a href="#modules">Modules</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="mod" href="collections/index.html" title='rayon::collections mod'>collections</a></td><td class='docblock-short'><p>Parallel iterator types for <a href="https://doc.rust-lang.org/stable/std/collections/">standard collections</a></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="iter/index.html" title='rayon::iter mod'>iter</a></td><td class='docblock-short'><p>Traits for writing parallel programs using an iterator-style interface</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="option/index.html" title='rayon::option mod'>option</a></td><td class='docblock-short'><p>Parallel iterator types for <a href="https://doc.rust-lang.org/stable/std/option/">options</a></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="prelude/index.html" title='rayon::prelude mod'>prelude</a></td><td class='docblock-short'><p>The rayon prelude imports the various <code>ParallelIterator</code> traits.
|
|
|
The intention is that one can include <code>use rayon::prelude::*</code> and
|
|
|
have easy access to the various traits and methods you will need.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="range/index.html" title='rayon::range mod'>range</a></td><td class='docblock-short'><p>Parallel iterator types for <a href="https://doc.rust-lang.org/core/ops/struct.Range.html">ranges</a>,
|
|
|
the type for values created by <code>a..b</code> expressions</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="range_inclusive/index.html" title='rayon::range_inclusive mod'>range_inclusive</a></td><td class='docblock-short'><p>Parallel iterator types for <a href="https://doc.rust-lang.org/core/ops/struct.RangeInclusive.html">inclusive ranges</a>,
|
|
|
the type for values created by <code>a..=b</code> expressions</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="result/index.html" title='rayon::result mod'>result</a></td><td class='docblock-short'><p>Parallel iterator types for <a href="https://doc.rust-lang.org/stable/std/result/">results</a></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="slice/index.html" title='rayon::slice mod'>slice</a></td><td class='docblock-short'><p>Parallel iterator types for <a href="https://doc.rust-lang.org/stable/std/slice/">slices</a></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="str/index.html" title='rayon::str mod'>str</a></td><td class='docblock-short'><p>Parallel iterator types for <a href="https://doc.rust-lang.org/stable/std/str/">strings</a></p>
|
|
|
</td></tr><tr class='module-item'><td><a class="mod" href="vec/index.html" title='rayon::vec mod'>vec</a></td><td class='docblock-short'><p>Parallel iterator types for <a href="https://doc.rust-lang.org/stable/std/vec/">vectors</a> (<code>Vec<T></code>)</p>
|
|
|
</td></tr></table><h2 id='structs' class='section-header'><a href="#structs">Structs</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="struct" href="struct.FnContext.html" title='rayon::FnContext struct'>FnContext</a></td><td class='docblock-short'><p>Provides the calling context to a closure called by <code>join_context</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.Scope.html" title='rayon::Scope struct'>Scope</a></td><td class='docblock-short'><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>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ScopeFifo.html" title='rayon::ScopeFifo struct'>ScopeFifo</a></td><td class='docblock-short'><p>Represents a fork-join scope which can be used to spawn any number of tasks.
|
|
|
Those spawned from the same thread are prioritized in relative FIFO order.
|
|
|
See <a href="fn.scope_fifo.html"><code>scope_fifo()</code></a> for more information.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ThreadBuilder.html" title='rayon::ThreadBuilder struct'>ThreadBuilder</a></td><td class='docblock-short'><p>Thread builder used for customization via
|
|
|
<a href="struct.ThreadPoolBuilder.html#method.spawn_handler"><code>ThreadPoolBuilder::spawn_handler</code></a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ThreadPool.html" title='rayon::ThreadPool struct'>ThreadPool</a></td><td class='docblock-short'><p>Represents a user created <a href="https://en.wikipedia.org/wiki/Thread_pool">thread-pool</a>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ThreadPoolBuildError.html" title='rayon::ThreadPoolBuildError struct'>ThreadPoolBuildError</a></td><td class='docblock-short'><p>Error when initializing a thread pool.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="struct" href="struct.ThreadPoolBuilder.html" title='rayon::ThreadPoolBuilder struct'>ThreadPoolBuilder</a></td><td class='docblock-short'><p>Used to create a new <a href="struct.ThreadPool.html"><code>ThreadPool</code></a> or to configure the global rayon thread pool.</p>
|
|
|
</td></tr></table><h2 id='functions' class='section-header'><a href="#functions">Functions</a></h2>
|
|
|
<table><tr class='module-item'><td><a class="fn" href="fn.current_num_threads.html" title='rayon::current_num_threads fn'>current_num_threads</a></td><td class='docblock-short'><p>Returns the number of threads in the current registry. If this
|
|
|
code is executing within a Rayon thread-pool, then this will be
|
|
|
the number of threads for the thread-pool of the current
|
|
|
thread. Otherwise, it will be the number of threads for the global
|
|
|
thread-pool.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.current_thread_index.html" title='rayon::current_thread_index fn'>current_thread_index</a></td><td class='docblock-short'><p>If called from a Rayon worker thread, returns the index of that
|
|
|
thread within its current pool; if not called from a Rayon thread,
|
|
|
returns <code>None</code>.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.join.html" title='rayon::join fn'>join</a></td><td class='docblock-short'><p>Takes two closures and <em>potentially</em> runs them in parallel. It
|
|
|
returns a pair of the results from those closures.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.join_context.html" title='rayon::join_context fn'>join_context</a></td><td class='docblock-short'><p>Identical to <code>join</code>, except that the closures have a parameter
|
|
|
that provides context for the way the closure has been called,
|
|
|
especially indicating whether they're executing on a different
|
|
|
thread than where <code>join_context</code> was called. This will occur if
|
|
|
the second job is stolen by a different thread, or if
|
|
|
<code>join_context</code> was called from outside the thread pool to begin
|
|
|
with.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.scope.html" title='rayon::scope fn'>scope</a></td><td class='docblock-short'><p>Create a "fork-join" scope <code>s</code> 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>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.scope_fifo.html" title='rayon::scope_fifo fn'>scope_fifo</a></td><td class='docblock-short'><p>Create 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>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.spawn.html" title='rayon::spawn fn'>spawn</a></td><td class='docblock-short'><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.html">the <code>scope()</code>
|
|
|
function</a> to create a scope.</p>
|
|
|
</td></tr><tr class='module-item'><td><a class="fn" href="fn.spawn_fifo.html" title='rayon::spawn_fifo fn'>spawn_fifo</a></td><td class='docblock-short'><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>
|
|
|
</td></tr></table></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> |
