| <!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="Conversion trait to convert an `Iterator` to a `ParallelIterator`."><meta name="keywords" content="rust, rustlang, rust-lang, ParallelBridge"><title>ParallelBridge in rayon::iter - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Regular.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../FiraSans-Medium.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Regular.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceSerif4-Bold.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../SourceCodePro-Semibold.ttf.woff2"><link rel="stylesheet" href="../../normalize.css"><link rel="stylesheet" href="../../rustdoc.css" id="mainThemeStyle"><link rel="stylesheet" href="../../ayu.css" disabled><link rel="stylesheet" href="../../dark.css" disabled><link rel="stylesheet" href="../../light.css" id="themeStyle"><script id="default-settings" ></script><script src="../../storage.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../main.js"></script><noscript><link rel="stylesheet" href="../../noscript.css"></noscript><link rel="alternate icon" type="image/png" href="../../favicon-16x16.png"><link rel="alternate icon" type="image/png" href="../../favicon-32x32.png"><link rel="icon" type="image/svg+xml" href="../../favicon.svg"></head><body class="rustdoc trait"><!--[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><a class="sidebar-logo" href="../../rayon/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../rayon/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">ParallelBridge</a></h2><div class="sidebar-elems"><section><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.par_bridge">par_bridge</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rayon::iter</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><form class="search-form"><div class="search-container"><span></span><input class="search-input" name="search" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" title="help" tabindex="-1"><a href="../../help.html">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../wheel.svg"></a></div></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1 class="fqn">Trait <a href="../index.html">rayon</a>::<wbr><a href="index.html">iter</a>::<wbr><a class="trait" href="#">ParallelBridge</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/rayon/iter/par_bridge.rs.html#43-46">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust trait"><code>pub trait ParallelBridge: Sized { |
| fn <a href="#tymethod.par_bridge" class="fnname">par_bridge</a>(self) -> <a class="struct" href="struct.IterBridge.html" title="struct rayon::iter::IterBridge">IterBridge</a><Self>; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <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"><code><span class="kw">use </span>rayon::iter::ParallelBridge; |
| <span class="kw">use </span>rayon::prelude::ParallelIterator; |
| <span class="kw">use </span>std::sync::mpsc::channel; |
| |
| <span class="kw">let </span>rx = { |
| <span class="kw">let </span>(tx, rx) = channel(); |
| |
| tx.send(<span class="string">"one!"</span>); |
| tx.send(<span class="string">"two!"</span>); |
| tx.send(<span class="string">"three!"</span>); |
| |
| rx |
| }; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>output: Vec<<span class="kw-2">&</span><span class="lifetime">'static </span>str> = rx.into_iter().par_bridge().collect(); |
| output.sort_unstable(); |
| |
| <span class="macro">assert_eq!</span>(<span class="kw-2">&*</span>output, <span class="kw-2">&</span>[<span class="string">"one!"</span>, <span class="string">"three!"</span>, <span class="string">"two!"</span>]);</code></pre></div> |
| </div></details><h2 id="required-methods" class="small-section-header">Required Methods<a href="#required-methods" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.par_bridge" class="method has-srclink"><a class="srclink rightside" href="../../src/rayon/iter/par_bridge.rs.html#45">source</a><h4 class="code-header">fn <a href="#tymethod.par_bridge" class="fnname">par_bridge</a>(self) -> <a class="struct" href="struct.IterBridge.html" title="struct rayon::iter::IterBridge">IterBridge</a><Self></h4></section></summary><div class="docblock"><p>Creates a bridge from this type to a <code>ParallelIterator</code>.</p> |
| </div></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"><section id="impl-ParallelBridge-for-T" class="impl has-srclink"><a class="srclink rightside" href="../../src/rayon/iter/par_bridge.rs.html#48-55">source</a><a href="#impl-ParallelBridge-for-T" class="anchor"></a><h3 class="code-header">impl<T: Iterator + Send> <a class="trait" href="trait.ParallelBridge.html" title="trait rayon::iter::ParallelBridge">ParallelBridge</a> for T<span class="where fmt-newline">where<br> T::Item: Send,</span></h3></section></div><script src="../../implementors/rayon/iter/par_bridge/trait.ParallelBridge.js" async></script></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="rayon" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
