|
|
<!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 `Consumer` trait in crate `rayon`."><meta name="keywords" content="rust, rustlang, rust-lang, Consumer"><title>rayon::iter::plumbing::Consumer - 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 Consumer</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.Folder">Folder</a><a href="#associatedtype.Reducer">Reducer</a><a href="#associatedtype.Result">Result</a></div><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.full">full</a><a href="#tymethod.into_folder">into_folder</a><a href="#tymethod.split_at">split_at</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: 'Consumer', 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#128-151' 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=''>Consumer</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait Consumer<Item>: <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.Folder' class="type">Folder</a>: <a class="trait" href="../../../rayon/iter/plumbing/trait.Folder.html" title="trait rayon::iter::plumbing::Folder">Folder</a><Item, Result = Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Result" title="type rayon::iter::plumbing::Consumer::Result">Result</a>>;
|
|
|
type <a href='#associatedtype.Reducer' class="type">Reducer</a>: <a class="trait" href="../../../rayon/iter/plumbing/trait.Reducer.html" title="trait rayon::iter::plumbing::Reducer">Reducer</a><Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Result" title="type rayon::iter::plumbing::Consumer::Result">Result</a>>;
|
|
|
type <a href='#associatedtype.Result' class="type">Result</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.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, Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Reducer" title="type rayon::iter::plumbing::Consumer::Reducer">Reducer</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.into_folder' class='fnname'>into_folder</a>(self) -> Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Folder" title="type rayon::iter::plumbing::Consumer::Folder">Folder</a>;
|
|
|
<div class='item-spacer'></div> fn <a href='#tymethod.full' class='fnname'>full</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a>;
|
|
|
}</pre></div><div class='docblock'><p>A consumer is effectively a <a href="https://doc.rust-lang.org/std/iter/trait.Iterator.html#method.fold">generalized "fold" operation</a>,
|
|
|
and in fact each consumer will eventually be converted into a
|
|
|
<a href="trait.Folder.html"><code>Folder</code></a>. What makes a consumer special is that, like a
|
|
|
<a href="trait.Producer.html"><code>Producer</code></a>, it can be <strong>split</strong> into multiple consumers using
|
|
|
the <code>split_at</code> method. When a consumer is split, it produces two
|
|
|
consumers, as well as a <strong>reducer</strong>. The two consumers can be fed
|
|
|
items independently, and when they are done the reducer is used to
|
|
|
combine their two results into one. 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>
|
|
|
</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.Folder' class='method'><code id='Folder.t'>type <a href='#associatedtype.Folder' class="type">Folder</a>: <a class="trait" href="../../../rayon/iter/plumbing/trait.Folder.html" title="trait rayon::iter::plumbing::Folder">Folder</a><Item, Result = Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Result" title="type rayon::iter::plumbing::Consumer::Result">Result</a>></code></h3><div class='docblock'><p>The type of folder that this consumer can be converted into.</p>
|
|
|
</div><h3 id='associatedtype.Reducer' class='method'><code id='Reducer.t'>type <a href='#associatedtype.Reducer' class="type">Reducer</a>: <a class="trait" href="../../../rayon/iter/plumbing/trait.Reducer.html" title="trait rayon::iter::plumbing::Reducer">Reducer</a><Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Result" title="type rayon::iter::plumbing::Consumer::Result">Result</a>></code></h3><div class='docblock'><p>The type of reducer that is produced if this consumer is split.</p>
|
|
|
</div><h3 id='associatedtype.Result' class='method'><code id='Result.t'>type <a href='#associatedtype.Result' class="type">Result</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 result that this consumer will ultimately 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.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, Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Reducer" title="type rayon::iter::plumbing::Consumer::Reducer">Reducer</a><a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.tuple.html">)</a></code></h3><div class='docblock'><p>Divide the consumer into two consumers, one processing items
|
|
|
<code>0..index</code> and one processing items from <code>index..</code>. Also
|
|
|
produces a reducer that can be used to reduce the results at
|
|
|
the end.</p>
|
|
|
</div><h3 id='tymethod.into_folder' class='method'><code id='into_folder.v'>fn <a href='#tymethod.into_folder' class='fnname'>into_folder</a>(self) -> Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Folder" title="type rayon::iter::plumbing::Consumer::Folder">Folder</a></code></h3><div class='docblock'><p>Convert the consumer into a folder that can consume items
|
|
|
sequentially, eventually producing a final result.</p>
|
|
|
</div><h3 id='tymethod.full' class='method'><code id='full.v'>fn <a href='#tymethod.full' class='fnname'>full</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></code></h3><div class='docblock'><p>Hint whether this <code>Consumer</code> would like to stop processing
|
|
|
further items, e.g. if a search has been completed.</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.Consumer.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> |
