You can not select more than 25 topics
Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
32 lines
79 KiB
32 lines
79 KiB
5 years ago
|
<!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 `IntoParallelIterator` trait in crate `rayon`."><meta name="keywords" content="rust, rustlang, rust-lang, IntoParallelIterator"><title>rayon::iter::IntoParallelIterator - 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 IntoParallelIterator</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#associated-types">Associated Types</a><div class="sidebar-links"><a href="#associatedtype.Iter">Iter</a><a href="#associatedtype.Item">Item</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.into_par_iter">into_par_iter</a></div><a class="sidebar-title" href="#foreign-impls">Implementations on Foreign Types</a><div class="sidebar-links"><a href="#impl-IntoParallelIterator-for-%26%27a%20BTreeMap%3CK%2C%20V%3E">&'a BTreeMap<K, V></a><a href="#impl-IntoParallelIterator-for-%26%27a%20BTreeSet%3CT%3E">&'a BTreeSet<T></a><a href="#impl-IntoParallelIterator-for-%26%27a%20BinaryHeap%3CT%3E">&'a BinaryHeap<T></a><a href="#impl-IntoParallelIterator-for-%26%27a%20HashMap%3CK%2C%20V%2C%20S%3E">&'a HashMap<K, V, S></a><a href="#impl-IntoParallelIterator-for-%26%27a%20HashSet%3CT%2C%20S%3E">&'a HashSet<T, S></a><a href="#impl-IntoParallelIterator-for-%26%27a%20LinkedList%3CT%3E">&'a LinkedList<T></a><a href="#impl-IntoParallelIterator-for-%26%27a%20Option%3CT%3E">&'a Option<T></a><a href="#impl-IntoParallelIterator-for-%26%27a%20Result%3CT%2C%20E%3E">&'a Result<T, E></a><a href="#impl-IntoParallelIterator-for-%26%27a%20VecDeque%3CT%3E">&'a VecDeque<T></a><a href="#impl-IntoParallelIterator-for-%26%27a%20mut%20BTreeMap%3CK%2C%20V%3E">&'a mut BTreeMap<K, V></a><a href="#impl-IntoParallelIterator-for-%26%27a%20mut%20HashMap%3CK%2C%20V%2C%20S%3E">&'a mut HashMap<K, V, S></a><a href="#impl-IntoParallelIterator-for-%26%27a%20mut%20LinkedList%3CT%3E">&'a mut LinkedList<T></a><a href="#impl-IntoParallelIterator-for-%26%27a%20mut%20Option%3CT%3E">&'a mut Option<T></a><a href="#impl-IntoParallelIterator-for-%26%27a%20mut%20Result%3CT%2C%20E%3E">&'a mut Result<T, E></a><a href="#impl-IntoParallelIterator-for-%26%27a%20mut%20VecDeque%3CT%3E">&'a mut VecDeque<T></a><a href="#impl-IntoParallelIterator-for-%26%27data%20%5BT%5D">&'data [T]</a><a href="#impl-IntoParallelIterator-for-%26%27data%20Vec%3CT%3E">&'data Vec<T></a><a href="#impl-IntoParallelIterator-for-%26%27data%20mut%20%5BT%5D">&'data mut [T]</a><a href="#impl-IntoParallelIterator-for-%26%27data%20mut%20Vec%3CT%3E">&'data mut Vec<T></a><a href="#impl-IntoParallelIterator-for-BTreeMap%3CK%2C%20V%3E">BTreeMap<K, V></a><a href="#impl-IntoParallelIterator-for-BTreeSet%3CT%3E">BTreeSet<T></a><a href="#impl-IntoParallelIterator-for-BinaryHeap%3CT%3E">Binar
|
||
|
|
type <a href='#associatedtype.Iter' class="type">Iter</a>: <a class="trait" href="../../rayon/iter/trait.ParallelIterator.html" title="trait rayon::iter::ParallelIterator">ParallelIterator</a><Item = Self::<a class="type" href="../../rayon/iter/trait.IntoParallelIterator.html#associatedtype.Item" title="type rayon::iter::IntoParallelIterator::Item">Item</a>>;
|
||
|
|
type <a href='#associatedtype.Item' class="type">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>;
|
||
|
|
fn <a href='#tymethod.into_par_iter' class='fnname'>into_par_iter</a>(self) -> Self::<a class="type" href="../../rayon/iter/trait.IntoParallelIterator.html#associatedtype.Iter" title="type rayon::iter::IntoParallelIterator::Iter">Iter</a>;
|
||
|
|
}</pre></div><div class='docblock'><p><code>IntoParallelIterator</code> implements the conversion to a <a href="trait.ParallelIterator.html"><code>ParallelIterator</code></a>.</p>
|
||
|
|
<p>By implementing <code>IntoParallelIterator</code> for a type, you define how it will
|
||
|
|
transformed into an iterator. This is a parallel version of the standard
|
||
|
|
library's <a href="https://doc.rust-lang.org/std/iter/trait.IntoIterator.html"><code>std::iter::IntoIterator</code></a> trait.</p>
|
||
|
|
</div>
|
||
|
|
<h2 id='associated-types' class='small-section-header'>Associated Types<a href='#associated-types' class='anchor'></a></h2><div class='methods'><h3 id='associatedtype.Iter' class='method'><code id='Iter.t'>type <a href='#associatedtype.Iter' class="type">Iter</a>: <a class="trait" href="../../rayon/iter/trait.ParallelIterator.html" title="trait rayon::iter::ParallelIterator">ParallelIterator</a><Item = Self::<a class="type" href="../../rayon/iter/trait.IntoParallelIterator.html#associatedtype.Item" title="type rayon::iter::IntoParallelIterator::Item">Item</a>></code></h3><div class='docblock'><p>The parallel iterator type that will be created.</p>
|
||
|
|
</div><h3 id='associatedtype.Item' class='method'><code id='Item.t'>type <a href='#associatedtype.Item' class="type">Item</a>: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a></code></h3><div class='docblock'><p>The type of item that the parallel iterator will produce.</p>
|
||
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
||
|
|
<h2 id='required-methods' class='small-section-header'>Required methods<a href='#required-methods' class='anchor'></a></h2><div class='methods'><h3 id='tymethod.into_par_iter' class='method'><code id='into_par_iter.v'>fn <a href='#tymethod.into_par_iter' class='fnname'>into_par_iter</a>(self) -> Self::<a class="type" href="../../rayon/iter/trait.IntoParallelIterator.html#associatedtype.Iter" title="type rayon::iter::IntoParallelIterator::Iter">Iter</a></code></h3><div class='docblock'><p>Converts <code>self</code> into a parallel iterator.</p>
|
||
|
|
<h1 id="examples" class="section-header"><a href="#examples">Examples</a></h1>
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
||
|
|
|
||
|
|
<span class="macro">println</span><span class="macro">!</span>(<span class="string">"counting in parallel:"</span>);
|
||
|
|
(<span class="number">0</span>..<span class="number">100</span>).<span class="ident">into_par_iter</span>()
|
||
|
|
.<span class="ident">for_each</span>(<span class="op">|</span><span class="ident">i</span><span class="op">|</span> <span class="macro">println</span><span class="macro">!</span>(<span class="string">"{}"</span>, <span class="ident">i</span>));</pre></div>
|
||
|
|
<p>This conversion is often implicit for arguments to methods like <a href="trait.IndexedParallelIterator.html#method.zip"><code>zip</code></a>.</p>
|
||
|
|
|
||
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered">
|
||
|
|
<span class="kw">use</span> <span class="ident">rayon</span>::<span class="ident">prelude</span>::<span class="kw-2">*</span>;
|
||
|
|
|
||
|
|
<span class="kw">let</span> <span class="ident">v</span>: <span class="ident">Vec</span><span class="op"><</span><span class="kw">_</span><span class="op">></span> <span class="op">=</span> (<span class="number">0</span>..<span class="number">5</span>).<span class="ident">into_par_iter</span>().<span class="ident">zip</span>(<span class="number">5</span>..<span class="number">10</span>).<span class="ident">collect</span>();
|
||
|
|
<span class="macro">assert_eq</span><span class="macro">!</span>(<span class="ident">v</span>, [(<span class="number">0</span>, <span class="number">5</span>), (<span class="number">1</span>, <span class="number">6</span>), (<span class="number">2</span>, <span class="number">7</span>), (<span class="number">3</span>, <span class="number">8</span>), (<span class="number">4</span>, <span class="number">9</span>)]);</pre></div>
|
||
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
||
|
|
<h2 id='foreign-impls' class='small-section-header'>Implementations on Foreign Types<a href='#foreign-impls' class='anchor'></a></h2><h3 id='impl-IntoParallelIterator-for-BinaryHeap%3CT%3E' class='impl'><code class='in-band'>impl<T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>> <a class="trait" href="../../rayon/iter/trait.IntoParallelIterator.html" title="trait rayon::iter::IntoParallelIterator">IntoParallelIterator</a> for <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/collections/binary_heap/struct.BinaryHeap.html" title="struct alloc::collections::binary_heap::BinaryHeap">BinaryHeap</a><T></code><a href='#impl-IntoParallelIterator-for-BinaryHeap%3CT%3E' class='anchor'></a><a class='srclink' href='../../src/rayon/collections/binary_heap.rs.html#18-27' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-1' class="type"><code id='Item.t-1'>type <a href='#associatedtype.Item' class="type">Item</a> = T</code></h4><h4 id='associatedtype.Iter-1' class="type"><code id='Iter.t-1'>type <a href='#associatedtype.Iter' class="type">Iter</a> = <a class="struct" href="../../rayon/collections/binary_heap/struct.IntoIter.html" title="struct rayon::collections::binary_heap::IntoIter">IntoIter</a><T></code></h4><h4 id='method.into_par_iter' class="method hidden"><code id='into_par_iter.v-1'>fn <a href='#method.into_par_iter' class='fnname'>into_par_iter</a>(self) -> Self::<a class="type" href="../../rayon/iter/trait.IntoParallelIterator.html#associatedtype.Iter" title="type rayon::iter::IntoParallelIterator::Iter">Iter</a></code><a class='srclink' href='../../src/rayon/collections/binary_heap.rs.html#22-26' title='goto source code'>[src]</a></h4></div><h3 id='impl-IntoParallelIterator-for-%26%27a%20BinaryHeap%3CT%3E' class='impl'><code class='in-band'>impl<'a, T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/cmp/trait.Ord.html" title="trait core::cmp::Ord">Ord</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a>> <a class="trait" href="../../rayon/iter/trait.IntoParallelIterator.html" title="trait rayon::iter::IntoParallelIterator">IntoParallelIterator</a> for &'a <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/collections/binary_heap/struct.BinaryHeap.html" title="struct alloc::collections::binary_heap::BinaryHeap">BinaryHeap</a><T></code><a href='#impl-IntoParallelIterator-for-%26%27a%20BinaryHeap%3CT%3E' class='anchor'></a><a class='srclink' href='../../src/rayon/collections/mod.rs.html#12-20' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Item-2' class="type"><code id='Item.t-2'>type <a href='#associatedtype.Item' class="type">Item</a> = <&'a <a class="struct" href="https://doc.rust-lang.org/nightly/alloc/collections/binary_heap/struct.BinaryHeap.html" title="struct alloc::collections::binary_heap::BinaryHeap">BinaryHeap</a><T> as <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>>::<a class="type" href="https://doc.rust-lang.org/nightly/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a></code></h4><h4 id='associatedtype.Iter-2' class="type"><code id='Iter.t-2'>type <a href='#associatedtype.Iter' class="type">Iter</a> = <a class="struct" href="../../rayon/collections/binary_heap/struct.Iter.html" title="struct rayon::collections::binary_heap::Iter">Iter</a><'a, T></code></h4><h4 id='method.into_par_iter-1' class="method hidden"><code id='into_par_iter.v-2'>fn <a href='#method.into_par_iter' class='fnname'>into_par_iter</a>(self) ->
|
||
|
|
<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-IntoParallelIterator' class='impl'><code class='in-band'>impl<T: <a class="trait" href="../../rayon/iter/trait.ParallelIterator.html" title="trait rayon::iter::ParallelIterator">ParallelIterator</a>> IntoParallelIterator for T</code><a href='#impl-IntoParallelIterator' class='anchor'></a><a class='srclink' href='../../src/rayon/iter/mod.rs.html#1974-1981' title='goto source code'>[src]</a></h3><div class='impl-items'><h4 id='associatedtype.Iter-32' class="type"><code id='Iter.t-32'>type <a href='#associatedtype.Iter-32' class="type">Iter</a> = T</code></h4><h4 id='associatedtype.Item-32' class="type"><code id='Item.t-32'>type <a href='#associatedtype.Item-32' class="type">Item</a> = T::<a class="type" href="../../rayon/iter/trait.ParallelIterator.html#associatedtype.Item" title="type rayon::iter::ParallelIterator::Item">Item</a></code></h4><h4 id='method.into_par_iter-31' class="method hidden"><code id='into_par_iter.v-32'>fn <a href='#method.into_par_iter-31' class='fnname'>into_par_iter</a>(self) -> T</code><a class='srclink' href='../../src/rayon/iter/mod.rs.html#1978-1980' 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/iter/trait.IntoParallelIterator.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>
|