29 lines
10 KiB
HTML
29 lines
10 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="`IntoParallelRefIterator` implements the conversion to a `ParallelIterator`, providing shared references to the data."><title>IntoParallelRefIterator in rayon::iter - 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 trait"><!--[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="#">IntoParallelRefIterator</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="#">Into<wbr>Parallel<wbr>RefIterator</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Item" title="Item">Item</a></li><li><a href="#associatedtype.Iter" title="Iter">Iter</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.par_iter" title="par_iter">par_iter</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In rayon::<wbr>iter</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>::<wbr><a href="index.html">iter</a></div><h1>Trait <span class="trait">Into<wbr>Parallel<wbr>RefIterator</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/iter/mod.rs.html#261-285">Source</a> </span></div><pre class="rust item-decl"><code>pub trait IntoParallelRefIterator<'data> {
|
|
type <a href="#associatedtype.Iter" class="associatedtype">Iter</a>: <a class="trait" href="trait.ParallelIterator.html" title="trait rayon::iter::ParallelIterator">ParallelIterator</a><Item = Self::<a class="associatedtype" href="trait.IntoParallelRefIterator.html#associatedtype.Item" title="type rayon::iter::IntoParallelRefIterator::Item">Item</a>>;
|
|
type <a href="#associatedtype.Item" class="associatedtype">Item</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> + 'data;
|
|
|
|
// Required method
|
|
fn <a href="#tymethod.par_iter" class="fn">par_iter</a>(&'data self) -> Self::<a class="associatedtype" href="trait.IntoParallelRefIterator.html#associatedtype.Iter" title="type rayon::iter::IntoParallelRefIterator::Iter">Iter</a>;
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p><code>IntoParallelRefIterator</code> implements the conversion to a
|
|
<a href="trait.ParallelIterator.html" title="trait rayon::iter::ParallelIterator"><code>ParallelIterator</code></a>, providing shared references to the data.</p>
|
|
<p>This is a parallel version of the <code>iter()</code> method
|
|
defined by various collections.</p>
|
|
<p>This trait is automatically implemented
|
|
<code>for I where &I: IntoParallelIterator</code>. In most cases, users
|
|
will want to implement <a href="trait.IntoParallelIterator.html" title="trait rayon::iter::IntoParallelIterator"><code>IntoParallelIterator</code></a> rather than implement
|
|
this trait directly.</p>
|
|
</div></details><h2 id="required-associated-types" class="section-header">Required Associated Types<a href="#required-associated-types" class="anchor">§</a></h2><div class="methods"><details class="toggle" open><summary><section id="associatedtype.Iter" class="method"><a class="src rightside" href="../../src/rayon/iter/mod.rs.html#263">Source</a><h4 class="code-header">type <a href="#associatedtype.Iter" class="associatedtype">Iter</a>: <a class="trait" href="trait.ParallelIterator.html" title="trait rayon::iter::ParallelIterator">ParallelIterator</a><Item = Self::<a class="associatedtype" href="trait.IntoParallelRefIterator.html#associatedtype.Item" title="type rayon::iter::IntoParallelRefIterator::Item">Item</a>></h4></section></summary><div class="docblock"><p>The type of the parallel iterator that will be returned.</p>
|
|
</div></details><details class="toggle" open><summary><section id="associatedtype.Item" class="method"><a class="src rightside" href="../../src/rayon/iter/mod.rs.html#267">Source</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</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> + 'data</h4></section></summary><div class="docblock"><p>The type of item that the parallel iterator will produce.
|
|
This will typically be an <code>&'data T</code> reference type.</p>
|
|
</div></details></div><h2 id="required-methods" class="section-header">Required Methods<a href="#required-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="tymethod.par_iter" class="method"><a class="src rightside" href="../../src/rayon/iter/mod.rs.html#284">Source</a><h4 class="code-header">fn <a href="#tymethod.par_iter" class="fn">par_iter</a>(&'data self) -> Self::<a class="associatedtype" href="trait.IntoParallelRefIterator.html#associatedtype.Iter" title="type rayon::iter::IntoParallelRefIterator::Iter">Iter</a></h4></section></summary><div class="docblock"><p>Converts <code>self</code> into a parallel iterator.</p>
|
|
<h5 id="examples"><a class="doc-anchor" href="#examples">§</a>Examples</h5>
|
|
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>rayon::prelude::<span class="kw-2">*</span>;
|
|
|
|
<span class="kw">let </span>v: Vec<<span class="kw">_</span>> = (<span class="number">0</span>..<span class="number">100</span>).collect();
|
|
<span class="macro">assert_eq!</span>(v.par_iter().sum::<i32>(), <span class="number">100 </span>* <span class="number">99 </span>/ <span class="number">2</span>);
|
|
|
|
<span class="comment">// `v.par_iter()` is shorthand for `(&v).into_par_iter()`,
|
|
// producing the exact same references.
|
|
</span><span class="macro">assert!</span>(v.par_iter().zip(<span class="kw-2">&</span>v)
|
|
.all(|(a, b)| std::ptr::eq(a, b)));</code></pre></div></div></details></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"><details class="toggle implementors-toggle"><summary><section id="impl-IntoParallelRefIterator%3C'data%3E-for-I" class="impl"><a class="src rightside" href="../../src/rayon/iter/mod.rs.html#287-297">Source</a><a href="#impl-IntoParallelRefIterator%3C'data%3E-for-I" class="anchor">§</a><h3 class="code-header">impl<'data, I: 'data + ?<a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>> <a class="trait" href="trait.IntoParallelRefIterator.html" title="trait rayon::iter::IntoParallelRefIterator">IntoParallelRefIterator</a><'data> for I<div class="where">where
|
|
<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&'data I</a>: <a class="trait" href="trait.IntoParallelIterator.html" title="trait rayon::iter::IntoParallelIterator">IntoParallelIterator</a>,</div></h3></section></summary><div class="impl-items"><section id="associatedtype.Iter-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/rayon/iter/mod.rs.html#291">Source</a><a href="#associatedtype.Iter-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Iter" class="associatedtype">Iter</a> = <<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&'data I</a> as <a class="trait" href="trait.IntoParallelIterator.html" title="trait rayon::iter::IntoParallelIterator">IntoParallelIterator</a>>::<a class="associatedtype" href="trait.IntoParallelIterator.html#associatedtype.Iter" title="type rayon::iter::IntoParallelIterator::Iter">Iter</a></h4></section><section id="associatedtype.Item-1" class="associatedtype trait-impl"><a class="src rightside" href="../../src/rayon/iter/mod.rs.html#292">Source</a><a href="#associatedtype.Item-1" class="anchor">§</a><h4 class="code-header">type <a href="#associatedtype.Item" class="associatedtype">Item</a> = <<a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.reference.html">&'data I</a> as <a class="trait" href="trait.IntoParallelIterator.html" title="trait rayon::iter::IntoParallelIterator">IntoParallelIterator</a>>::<a class="associatedtype" href="trait.IntoParallelIterator.html#associatedtype.Item" title="type rayon::iter::IntoParallelIterator::Item">Item</a></h4></section></div></details></div><script src="../../trait.impl/rayon/iter/trait.IntoParallelRefIterator.js" async></script></section></div></main></body></html> |