|
|
|
|
|
<!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 `Producer` trait in crate `rayon`."><meta name="keywords" content="rust, rustlang, rust-lang, Producer"><title>rayon::iter::plumbing::Producer - 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 Producer</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.Item">Item</a><a href="#associatedtype.IntoIter">IntoIter</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.into_iter">into_iter</a><a href="#tymethod.split_at">split_at</a></div><a class="sidebar-title" href="#provided-methods">Provided Methods</a><div class="sidebar-links"><a href="#method.fold_with">fold_with</a><a href="#method.max_len">max_len</a><a href="#method.min_len">min_len</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'>iter</a>::<wbr><a href='index.html'>plumbing</a></p><script>window.sidebarCurrent = {name: 'Producer', 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/plumbing/mod.rs.html#59-112' title='goto source code'>[src]</a></span><span class='in-band'>Trait <a href='../../index.html'>rayon</a>::<wbr><a href='../index.html'>iter</a>::<wbr><a href='index.html'>plumbing</a>::<wbr><a class="trait" href=''>Producer</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Producer: <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="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
|
|
|
|
type <a href='#associatedtype.Item' class="type">Item</a>;
|
|
|
|
|
|
type <a href='#associatedtype.IntoIter' class="type">IntoIter</a>: <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><Item = Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Producer.html#associatedtype.Item" title="type rayon::iter::plumbing::Producer::Item">Item</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="trait core::iter::traits::double_ended::DoubleEndedIterator">DoubleEndedIterator</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/exact_size/trait.ExactSizeIterator.html" title="trait core::iter::traits::exact_size::ExactSizeIterator">ExactSizeIterator</a>;
|
|
|
|
|
|
fn <a href='#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Producer.html#associatedtype.IntoIter" title="type rayon::iter::plumbing::Producer::IntoIter">IntoIter</a>;
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.split_at' class='fnname'>split_at</a>(self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;
|
|
|
|
|
|
|
|
|
|
|
|
fn <a href='#method.min_len' class='fnname'>min_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.max_len' class='fnname'>max_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a> { ... }
|
|
|
|
|
|
<div class='item-spacer'></div> fn <a href='#method.fold_with' class='fnname'>fold_with</a><F>(self, folder: F) -> F<br> <span class="where">where<br> F: <a class="trait" href="../../../rayon/iter/plumbing/trait.Folder.html" title="trait rayon::iter::plumbing::Folder">Folder</a><Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Producer.html#associatedtype.Item" title="type rayon::iter::plumbing::Producer::Item">Item</a>></span>,
|
|
|
|
|
|
{ ... }
|
|
|
|
|
|
}</pre></div><div class='docblock'><p>A <code>Producer</code> is effectively a "splittable <code>IntoIterator</code>". That
|
|
|
|
|
|
is, a producer is a value which can be converted into an iterator
|
|
|
|
|
|
at any time: at that point, it simply produces items on demand,
|
|
|
|
|
|
like any iterator. But what makes a <code>Producer</code> special is that,
|
|
|
|
|
|
<em>before</em> we convert to an iterator, we can also <strong>split</strong> it at a
|
|
|
|
|
|
particular point using the <code>split_at</code> method. This will yield up
|
|
|
|
|
|
two producers, one producing the items before that point, and one
|
|
|
|
|
|
producing the items after that point (these two producers can then
|
|
|
|
|
|
independently be split further, or be converted into iterators).
|
|
|
|
|
|
In Rayon, this splitting is used to divide between threads.
|
|
|
|
|
|
See <a href="https://github.com/rayon-rs/rayon/blob/master/src/iter/plumbing/README.md">the <code>plumbing</code> README</a> for further details.</p>
|
|
|
|
|
|
<p>Note that each producer will always produce a fixed number of
|
|
|
|
|
|
items N. However, this number N is not queryable through the API;
|
|
|
|
|
|
the consumer is expected to track it.</p>
|
|
|
|
|
|
<p>NB. You might expect <code>Producer</code> to extend the <code>IntoIterator</code>
|
|
|
|
|
|
trait. However, <a href="https://github.com/rust-lang/rust/issues/20671">rust-lang/rust#20671</a> prevents us from
|
|
|
|
|
|
declaring the DoubleEndedIterator and ExactSizeIterator
|
|
|
|
|
|
constraints on a required IntoIterator trait, so we inline
|
|
|
|
|
|
IntoIterator here until that issue is fixed.</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.Item' class='method'><code id='Item.t'>type <a href='#associatedtype.Item' class="type">Item</a></code></h3><div class='docblock'><p>The type of item that will be produced by this producer once
|
|
|
|
|
|
it is converted into an iterator.</p>
|
|
|
|
|
|
</div><h3 id='associatedtype.IntoIter' class='method'><code id='IntoIter.t'>type <a href='#associatedtype.IntoIter' class="type">IntoIter</a>: <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><Item = Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Producer.html#associatedtype.Item" title="type rayon::iter::plumbing::Producer::Item">Item</a>> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/double_ended/trait.DoubleEndedIterator.html" title="trait core::iter::traits::double_ended::DoubleEndedIterator">DoubleEndedIterator</a> + <a class="trait" href="https://doc.rust-lang.org/nightly/core/iter/traits/exact_size/trait.ExactSizeIterator.html" title="trait core::iter::traits::exact_size::ExactSizeIterator">ExactSizeIterator</a></code></h3><div class='docblock'><p>The type of iterator we will become.</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_iter' class='method'><code id='into_iter.v'>fn <a href='#tymethod.into_iter' class='fnname'>into_iter</a>(self) -> Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Producer.html#associatedtype.IntoIter" title="type rayon::iter::plumbing::Producer::IntoIter">IntoIter</a></code></h3><div class='docblock'><p>Convert <code>self</code> into an iterator; at this point, no more parallel splits
|
|
|
|
|
|
are possible.</p>
|
|
|
|
|
|
</div><h3 id='tymethod.split_at' class='method'><code id='split_at.v'>fn <a href='#tymethod.split_at' class='fnname'>split_at</a>(self, index: <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a>) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">(</a>Self, Self<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><div class='docblock'><p>Split into two producers; one produces items <code>0..index</code>, the
|
|
|
|
|
|
other <code>index..N</code>. Index must be less than or equal to <code>N</code>.</p>
|
|
|
|
|
|
</div></div><span class='loading-content'>Loading content...</span>
|
|
|
|
|
|
<h2 id='provided-methods' class='small-section-header'>Provided methods<a href='#provided-methods' class='anchor'></a></h2><div class='methods'><h3 id='method.min_len' class='method'><code id='min_len.v'>fn <a href='#method.min_len' class='fnname'>min_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>The minimum number of items that we will process
|
|
|
|
|
|
sequentially. Defaults to 1, which means that we will split
|
|
|
|
|
|
all the way down to a single item. This can be raised higher
|
|
|
|
|
|
using the <a href="../trait.IndexedParallelIterator.html#method.with_min_len"><code>with_min_len</code></a> method, which will force us to
|
|
|
|
|
|
create sequential tasks at a larger granularity. Note that
|
|
|
|
|
|
Rayon automatically normally attempts to adjust the size of
|
|
|
|
|
|
parallel splits to reduce overhead, so this should not be
|
|
|
|
|
|
needed.</p>
|
|
|
|
|
|
</div><h3 id='method.max_len' class='method'><code id='max_len.v'>fn <a href='#method.max_len' class='fnname'>max_len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></code></h3><div class='docblock'><p>The maximum number of items that we will process
|
|
|
|
|
|
sequentially. Defaults to MAX, which means that we can choose
|
|
|
|
|
|
not to split at all. This can be lowered using the
|
|
|
|
|
|
<a href="../trait.IndexedParallelIterator.html#method.with_max_len"><code>with_max_len</code></a> method, which will force us to create more
|
|
|
|
|
|
parallel tasks. Note that Rayon automatically normally
|
|
|
|
|
|
attempts to adjust the size of parallel splits to reduce
|
|
|
|
|
|
overhead, so this should not be needed.</p>
|
|
|
|
|
|
</div><h3 id='method.fold_with' class='method'><code id='fold_with.v'>fn <a href='#method.fold_with' class='fnname'>fold_with</a><F>(self, folder: F) -> F <span class="where fmt-newline">where<br> F: <a class="trait" href="../../../rayon/iter/plumbing/trait.Folder.html" title="trait rayon::iter::plumbing::Folder">Folder</a><Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Producer.html#associatedtype.Item" title="type rayon::iter::plumbing::Producer::Item">Item</a>>, </span></code></h3><div class='docblock'><p>Iterate the producer, feeding each element to <code>folder</code>, and
|
|
|
|
|
|
stop when the folder is full (or all elements have been consumed).</p>
|
|
|
|
|
|
<p>The provided implementation is sufficient for most iterables.</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'></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/plumbing/trait.Producer.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>
|
