30 lines
12 KiB
HTML
30 lines
12 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="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."><title>Consumer in rayon::iter::plumbing - 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="#">Consumer</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="#">Consumer</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><li><a href="#associatedtype.Folder" title="Folder">Folder</a></li><li><a href="#associatedtype.Reducer" title="Reducer">Reducer</a></li><li><a href="#associatedtype.Result" title="Result">Result</a></li></ul><h3><a href="#required-methods">Required Methods</a></h3><ul class="block"><li><a href="#tymethod.full" title="full">full</a></li><li><a href="#tymethod.into_folder" title="into_folder">into_folder</a></li><li><a href="#tymethod.split_at" title="split_at">split_at</a></li></ul><h3><a href="#dyn-compatibility">Dyn Compatibility</a></h3><h3><a href="#implementors">Implementors</a></h3></section><div id="rustdoc-modnav"><h2><a href="index.html">In rayon::<wbr>iter::<wbr>plumbing</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>::<wbr><a href="index.html">plumbing</a></div><h1>Trait <span class="trait">Consumer</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/plumbing/mod.rs.html#123-146">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Consumer<Item>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a> {
|
|
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>: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.split_at" class="fn">split_at</a>(self, index: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> (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="fn">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="fn">full</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a>;
|
|
}</code></pre><details class="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/1.93.1/core/iter/traits/iterator/trait.Iterator.html#method.fold" title="method core::iter::traits::iterator::Iterator::fold">generalized “fold” operation</a>,
|
|
and in fact each consumer will eventually be converted into a
|
|
<a href="trait.Folder.html" title="trait rayon::iter::plumbing::Folder"><code>Folder</code></a>. What makes a consumer special is that, like a
|
|
<a href="trait.Producer.html" title="trait rayon::iter::plumbing::Producer"><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/main/src/iter/plumbing/README.md">the <code>plumbing</code>
|
|
README</a> for further details.</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.Folder" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#125">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="toggle" open><summary><section id="associatedtype.Reducer" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#128">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="toggle" open><summary><section id="associatedtype.Result" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#131">Source</a><h4 class="code-header">type <a href="#associatedtype.Result" class="associatedtype">Result</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></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="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.split_at" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#137">Source</a><h4 class="code-header">fn <a href="#tymethod.split_at" class="fn">split_at</a>(self, index: <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.usize.html">usize</a>) -> (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="toggle method-toggle" open><summary><section id="tymethod.into_folder" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#141">Source</a><h4 class="code-header">fn <a href="#tymethod.into_folder" class="fn">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="toggle method-toggle" open><summary><section id="tymethod.full" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#145">Source</a><h4 class="code-header">fn <a href="#tymethod.full" class="fn">full</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/1.93.1/std/primitive.bool.html">bool</a></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="dyn-compatibility" class="section-header">Dyn Compatibility<a href="#dyn-compatibility" class="anchor">§</a></h2><div class="dyn-compatibility-info"><p>This trait is <b>not</b> <a href="https://doc.rust-lang.org/1.93.1/reference/items/traits.html#dyn-compatibility">dyn compatible</a>.</p><p><i>In older versions of Rust, dyn compatibility was called "object safety", so this trait is not object safe.</i></p></div><h2 id="implementors" class="section-header">Implementors<a href="#implementors" class="anchor">§</a></h2><div id="implementors-list"></div><script src="../../../trait.impl/rayon/iter/plumbing/trait.Consumer.js" async></script></section></div></main></body></html> |