|
|
<!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 `ParallelBridge` trait in crate `rayon`."><meta name="keywords" content="rust, rustlang, rust-lang, ParallelBridge"><title>rayon::prelude::ParallelBridge - 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 trait"><!--[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'>Trait ParallelBridge</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.par_bridge">par_bridge</a></div><a class="sidebar-title" href="#implementors">Implementors</a></div><p class='location'><a href='../index.html'>rayon</a>::<wbr><a href='index.html'>prelude</a></p><script>window.sidebarCurrent = {name: 'ParallelBridge', ty: 'trait', 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/iter/par_bridge.rs.html#46-49' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../index.html'>rayon</a>::<wbr><a href='index.html'>prelude</a>::<wbr><a class="trait" href=''>ParallelBridge</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait ParallelBridge: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
|
fn <a href='#tymethod.par_bridge' class='fnname'>par_bridge</a>(self) -> <a class="struct" href="../../rayon/iter/struct.IterBridge.html" title="struct rayon::iter::IterBridge">IterBridge</a><Self>;
|
|
|
}</pre></div><div class='docblock'><p>Conversion trait to convert an <code>Iterator</code> to a <code>ParallelIterator</code>.</p>
|
|
|
<p>This creates a "bridge" from a sequential iterator to a parallel one, by distributing its items
|
|
|
across the Rayon thread pool. This has the advantage of being able to parallelize just about
|
|
|
anything, but the resulting <code>ParallelIterator</code> can be less efficient than if you started with
|
|
|
<code>par_iter</code> instead. However, it can still be useful for iterators that are difficult to
|
|
|
parallelize by other means, like channels or file or network I/O.</p>
|
|
|
<p>The resulting iterator is not guaranteed to keep the order of the original iterator.</p>
|
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
|
|
<p>To use this trait, take an existing <code>Iterator</code> and call <code>par_bridge</code> on it. After that, you can
|
|
|
use any of the <code>ParallelIterator</code> methods:</p>
|
|
|
|
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">iter</span>::<span class="ident">ParallelBridge</span>;
|
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="ident">ParallelIterator</span>;
|
|
|
<span class="kw">use</span> <span class="ident">std</span>::<span class="ident">sync</span>::<span class="ident">mpsc</span>::<span class="ident">channel</span>;
|
|
|
|
|
|
<span class="kw">let</span> <span class="ident">rx</span> <span class="op">=</span> {
|
|
|
<span class="kw">let</span> (<span class="ident">tx</span>, <span class="ident">rx</span>) <span class="op">=</span> <span class="ident">channel</span>();
|
|
|
|
|
|
<span class="ident">tx</span>.<span class="ident">send</span>(<span class="string">"one!"</span>);
|
|
|
<span class="ident">tx</span>.<span class="ident">send</span>(<span class="string">"two!"</span>);
|
|
|
<span class="ident">tx</span>.<span class="ident">send</span>(<span class="string">"three!"</span>);
|
|
|
|
|
|
<span class="ident">rx</span>
|
|
|
};
|
|
|
|
|
|
<span class="kw">let</span> <span class="kw-2">mut</span> <span class="ident">output</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw-2">&</span><span class="lifetime">'static</span> <span class="ident">str</span><span class="op">></span> <span class="op">=</span> <span class="ident">rx</span>.<span class="ident">into_iter</span>().<span class="ident">par_bridge</span>().<span class="ident">collect</span>();
|
|
|
<span class="ident">output</span>.<span class="ident">sort_unstable</span>();
|
|
|
|
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="kw-2">&</span><span class="kw-2">*</span><span class="ident">output</span>, <span class="kw-2">&</span>[<span class="string">"one!"</span>, <span class="string">"three!"</span>, <span class="string">"two!"</span>]);</pre></div>
|
|
|
</div>
|
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.par_bridge' class='method'><code id='par_bridge.v'>fn <a href='#tymethod.par_bridge' class='fnname'>par_bridge</a>(self) -> <a class="struct" href="../../rayon/iter/struct.IterBridge.html" title="struct rayon::iter::IterBridge">IterBridge</a><Self></code></h3><div class='docblock'><p>Create a bridge from this type to a <code>ParallelIterator</code>.</p>
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
<h2 id='implementors' class='small-section-header'>Implementors<a href='#implementors' class='anchor'></a></h2><div class='item-list' id='implementors-list'><h3 id='impl-ParallelBridge' class='impl'><code class='in-band'>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html" title="trait core::iter::traits::iterator::Iterator">Iterator</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> ParallelBridge for T <span class="where fmt-newline">where<br> T::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/iterator/trait.Iterator.html#associatedtype.Item" title="type core::iter::traits::iterator::Iterator::Item">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>, </span></code><a href='#impl-ParallelBridge' class='anchor'></a><a class='srclink' href='../../src/rayon/iter/par_bridge.rs.html#51-58' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='method.par_bridge' class="method hidden"><code id='par_bridge.v-1'>fn <a href='#method.par_bridge' class='fnname'>par_bridge</a>(self) -> <a class="struct" href="../../rayon/iter/struct.IterBridge.html" title="struct rayon::iter::IterBridge">IterBridge</a><Self></code><a class='srclink' href='../../src/rayon/iter/par_bridge.rs.html#55-57' title='goto source code'>[src]</a></h4></div></div><span class='loading-content'>Loading content...</span><script type="text/javascript">window.inlined_types=new Set([]);</script><script type="text/javascript" async
|
|
|
src="../../implementors/rayon/prelude/trait.ParallelBridge.js">
|
|
|
</script></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> |
