| <!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="A consumer is effectively a generalized “fold” operation, and in fact each consumer will eventually be converted into a `Folder`. What makes a consumer special is that, like a `Producer`, it can be split into multiple consumers using the `split_at` method. When a consumer is split, it produces two consumers, as well as a reducer. 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 the `plumbing` README for further details."><meta name="keywords" content="rust, rustlang, rust-lang, Consumer"><title>Consumer in rayon::iter::plumbing - 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="#">Consumer</a></h2><div class="sidebar-elems"><section><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Folder">Folder</a></li><li><a href="#associatedtype.Reducer">Reducer</a></li><li><a href="#associatedtype.Result">Result</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.full">full</a></li><li><a href="#tymethod.into_folder">into_folder</a></li><li><a href="#tymethod.split_at">split_at</a></li></ul><h3><a href="#implementors">Implementors</a></h3></section><h2><a href="index.html">In rayon::iter::plumbing</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 href="index.html">plumbing</a>::<wbr><a class="trait" href="#">Consumer</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/plumbing/mod.rs.html#128-151">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 Consumer<Item>: Send + Sized { |
| type <a href="#associatedtype.Folder" class="associatedtype">Folder</a>: <a class="trait" href="trait.Folder.html" title="trait rayon::iter::plumbing::Folder">Folder</a><Item, Result = Self::<a class="associatedtype" href="trait.Consumer.html#associatedtype.Result" title="type rayon::iter::plumbing::Consumer::Result">Result</a>>; |
| type <a href="#associatedtype.Reducer" class="associatedtype">Reducer</a>: <a class="trait" href="trait.Reducer.html" title="trait rayon::iter::plumbing::Reducer">Reducer</a><Self::<a class="associatedtype" href="trait.Consumer.html#associatedtype.Result" title="type rayon::iter::plumbing::Consumer::Result">Result</a>>; |
| type <a href="#associatedtype.Result" class="associatedtype">Result</a>: Send; |
| |
| fn <a href="#tymethod.split_at" class="fnname">split_at</a>(self, index: usize) -> (Self, Self, Self::<a class="associatedtype" href="trait.Consumer.html#associatedtype.Reducer" title="type rayon::iter::plumbing::Consumer::Reducer">Reducer</a>); |
| <span class="item-spacer"></span> fn <a href="#tymethod.into_folder" class="fnname">into_folder</a>(self) -> Self::<a class="associatedtype" href="trait.Consumer.html#associatedtype.Folder" title="type rayon::iter::plumbing::Consumer::Folder">Folder</a>; |
| <span class="item-spacer"></span> fn <a href="#tymethod.full" class="fnname">full</a>(&self) -> bool; |
| }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><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></details><h2 id="required-associated-types" class="small-section-header">Required Associated Types<a href="#required-associated-types" class="anchor"></a></h2><div class="methods"><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Folder" class="method has-srclink"><a class="srclink rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#130">source</a><h4 class="code-header">type <a href="#associatedtype.Folder" class="associatedtype">Folder</a>: <a class="trait" href="trait.Folder.html" title="trait rayon::iter::plumbing::Folder">Folder</a><Item, Result = Self::<a class="associatedtype" href="trait.Consumer.html#associatedtype.Result" title="type rayon::iter::plumbing::Consumer::Result">Result</a>></h4></section></summary><div class="docblock"><p>The type of folder that this consumer can be converted into.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Reducer" class="method has-srclink"><a class="srclink rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#133">source</a><h4 class="code-header">type <a href="#associatedtype.Reducer" class="associatedtype">Reducer</a>: <a class="trait" href="trait.Reducer.html" title="trait rayon::iter::plumbing::Reducer">Reducer</a><Self::<a class="associatedtype" href="trait.Consumer.html#associatedtype.Result" title="type rayon::iter::plumbing::Consumer::Result">Result</a>></h4></section></summary><div class="docblock"><p>The type of reducer that is produced if this consumer is split.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="associatedtype.Result" class="method has-srclink"><a class="srclink rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#136">source</a><h4 class="code-header">type <a href="#associatedtype.Result" class="associatedtype">Result</a>: Send</h4></section></summary><div class="docblock"><p>The type of result that this consumer will ultimately produce.</p> |
| </div></details></div><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.split_at" class="method has-srclink"><a class="srclink rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#142">source</a><h4 class="code-header">fn <a href="#tymethod.split_at" class="fnname">split_at</a>(self, index: usize) -> (Self, Self, Self::<a class="associatedtype" href="trait.Consumer.html#associatedtype.Reducer" title="type rayon::iter::plumbing::Consumer::Reducer">Reducer</a>)</h4></section></summary><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></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.into_folder" class="method has-srclink"><a class="srclink rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#146">source</a><h4 class="code-header">fn <a href="#tymethod.into_folder" class="fnname">into_folder</a>(self) -> Self::<a class="associatedtype" href="trait.Consumer.html#associatedtype.Folder" title="type rayon::iter::plumbing::Consumer::Folder">Folder</a></h4></section></summary><div class="docblock"><p>Convert the consumer into a folder that can consume items |
| sequentially, eventually producing a final result.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="tymethod.full" class="method has-srclink"><a class="srclink rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#150">source</a><h4 class="code-header">fn <a href="#tymethod.full" class="fnname">full</a>(&self) -> bool</h4></section></summary><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></details></div><h2 id="implementors" class="small-section-header">Implementors<a href="#implementors" class="anchor"></a></h2><div id="implementors-list"></div><script src="../../../implementors/rayon/iter/plumbing/trait.Consumer.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> |
