28 lines
9.5 KiB
HTML
28 lines
9.5 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="The `Folder` trait encapsulates the standard fold operation. It can be fed many items using the `consume` method. At the end, once all items have been consumed, it can then be converted (using `complete`) into a final value."><title>Folder 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="#">Folder</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="#">Folder</a></h2><h3><a href="#required-associated-types">Required Associated Types</a></h3><ul class="block"><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.complete" title="complete">complete</a></li><li><a href="#tymethod.consume" title="consume">consume</a></li><li><a href="#tymethod.full" title="full">full</a></li></ul><h3><a href="#provided-methods">Provided Methods</a></h3><ul class="block"><li><a href="#method.consume_iter" title="consume_iter">consume_iter</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">Folder</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#154-188">Source</a> </span></div><pre class="rust item-decl"><code>pub trait Folder<Item>: <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.Result" class="associatedtype">Result</a>;
|
|
|
|
// Required methods
|
|
fn <a href="#tymethod.consume" class="fn">consume</a>(self, item: Item) -> Self;
|
|
<span class="item-spacer"></span> fn <a href="#tymethod.complete" class="fn">complete</a>(self) -> Self::<a class="associatedtype" href="trait.Folder.html#associatedtype.Result" title="type rayon::iter::plumbing::Folder::Result">Result</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>;
|
|
|
|
// Provided method
|
|
fn <a href="#method.consume_iter" class="fn">consume_iter</a><I>(self, iter: I) -> Self
|
|
<span class="where">where I: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = Item></span> { ... }
|
|
}</code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>The <code>Folder</code> trait encapsulates <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">the standard fold
|
|
operation</a>. It can be fed many items using the <code>consume</code>
|
|
method. At the end, once all items have been consumed, it can then
|
|
be converted (using <code>complete</code>) into a final value.</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.Result" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#156">Source</a><h4 class="code-header">type <a href="#associatedtype.Result" class="associatedtype">Result</a></h4></section></summary><div class="docblock"><p>The type of result that will ultimately be produced by the folder.</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.consume" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#159">Source</a><h4 class="code-header">fn <a href="#tymethod.consume" class="fn">consume</a>(self, item: Item) -> Self</h4></section></summary><div class="docblock"><p>Consume next item and return new sequential state.</p>
|
|
</div></details><details class="toggle method-toggle" open><summary><section id="tymethod.complete" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#183">Source</a><h4 class="code-header">fn <a href="#tymethod.complete" class="fn">complete</a>(self) -> Self::<a class="associatedtype" href="trait.Folder.html#associatedtype.Result" title="type rayon::iter::plumbing::Folder::Result">Result</a></h4></section></summary><div class="docblock"><p>Finish consuming items, produce 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#187">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>Folder</code> would like to stop processing
|
|
further items, e.g. if a search has been completed.</p>
|
|
</div></details></div><h2 id="provided-methods" class="section-header">Provided Methods<a href="#provided-methods" class="anchor">§</a></h2><div class="methods"><details class="toggle method-toggle" open><summary><section id="method.consume_iter" class="method"><a class="src rightside" href="../../../src/rayon/iter/plumbing/mod.rs.html#169-180">Source</a><h4 class="code-header">fn <a href="#method.consume_iter" class="fn">consume_iter</a><I>(self, iter: I) -> Self<div class="where">where
|
|
I: <a class="trait" href="https://doc.rust-lang.org/1.93.1/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a><Item = Item>,</div></h4></section></summary><div class="docblock"><p>Consume items from the iterator until full, and return new sequential state.</p>
|
|
<p>This method is <strong>optional</strong>. The default simply iterates over
|
|
<code>iter</code>, invoking <code>consume</code> and checking after each iteration
|
|
whether <code>full</code> returns false.</p>
|
|
<p>The main reason to override it is if you can provide a more
|
|
specialized, efficient implementation.</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.Folder.js" async></script></section></div></main></body></html> |