You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
Trac3r-rust/doc/rayon/iter/plumbing/trait.UnindexedConsumer.html

22 lines
7.4 KiB

5 years ago
<!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 `UnindexedConsumer` trait in crate `rayon`."><meta name="keywords" content="rust, rustlang, rust-lang, UnindexedConsumer"><title>rayon::iter::plumbing::UnindexedConsumer - 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">&#9776;</div><a href='../../../rayon/index.html'><div class='logo-container'><img src='../../../rust-logo.png' alt='logo'></div></a><p class='location'>Trait UnindexedConsumer</p><div class="sidebar-elems"><div class="block items"><a class="sidebar-title" href="#required-methods">Required Methods</a><div class="sidebar-links"><a href="#tymethod.split_off_left">split_off_left</a><a href="#tymethod.to_reducer">to_reducer</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: 'UnindexedConsumer', 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'>&#x2212;</span>]</a></span><a class='srclink' href='../../../src/rayon/iter/plumbing/mod.rs.html#213-226' 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=''>UnindexedConsumer</a></span></h1><div class="docblock type-decl hidden-by-usual-hider"><pre class='rust trait'>pub trait UnindexedConsumer&lt;I&gt;: <a class="trait" href="../../../rayon/iter/plumbing/trait.Consumer.html" title="trait rayon::iter::plumbing::Consumer">Consumer</a>&lt;I&gt; {
fn <a href='#tymethod.split_off_left' class='fnname'>split_off_left</a>(&amp;self) -&gt; Self;
<div class='item-spacer'></div> fn <a href='#tymethod.to_reducer' class='fnname'>to_reducer</a>(&amp;self) -&gt; Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Reducer" title="type rayon::iter::plumbing::Consumer::Reducer">Reducer</a>;
}</pre></div><div class='docblock'><p>A stateless consumer can be freely copied. These consumers can be
used like regular consumers, but they also support a
<code>split_off_left</code> method that does not take an index to split, but
simply splits at some arbitrary point (<code>for_each</code>, for example,
produces an unindexed consumer).</p>
</div>
<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_off_left' class='method'><code id='split_off_left.v'>fn <a href='#tymethod.split_off_left' class='fnname'>split_off_left</a>(&amp;self) -&gt; Self</code></h3><div class='docblock'><p>Splits off a &quot;left&quot; consumer and returns it. The <code>self</code>
consumer should then be used to consume the &quot;right&quot; portion of
the data. (The ordering matters for methods like find_first --
values produced by the returned value are given precedence
over values produced by <code>self</code>.) Once the left and right
halves have been fully consumed, you should reduce the results
with the result of <code>to_reducer</code>.</p>
</div><h3 id='tymethod.to_reducer' class='method'><code id='to_reducer.v'>fn <a href='#tymethod.to_reducer' class='fnname'>to_reducer</a>(&amp;self) -&gt; Self::<a class="type" href="../../../rayon/iter/plumbing/trait.Consumer.html#associatedtype.Reducer" title="type rayon::iter::plumbing::Consumer::Reducer">Reducer</a></code></h3><div class='docblock'><p>Creates a reducer that can be used to combine the results from
a split consumer.</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.UnindexedConsumer.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>&#9166;</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>