blob: 6a8699ce8610839e094266a3b97a180fea2e060b [file] [log] [blame]
<!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="Source of the Rust file `/root/.cargo/git/checkouts/rayon-3b3b152053499ede/a07ce2e/src/collections/mod.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>mod.rs - source</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="../../../source-script.js"></script><script defer src="../../../source-files.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 source"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><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></nav><main><div class="width-limiter"><nav class="sub"><a class="sub-logo-container" href="../../../rayon/index.html"><img class="rust-logo" src="../../../rust-logo.svg" alt="logo"></a><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="example-wrap"><pre class="src-line-numbers"><span id="1">1</span>
<span id="2">2</span>
<span id="3">3</span>
<span id="4">4</span>
<span id="5">5</span>
<span id="6">6</span>
<span id="7">7</span>
<span id="8">8</span>
<span id="9">9</span>
<span id="10">10</span>
<span id="11">11</span>
<span id="12">12</span>
<span id="13">13</span>
<span id="14">14</span>
<span id="15">15</span>
<span id="16">16</span>
<span id="17">17</span>
<span id="18">18</span>
<span id="19">19</span>
<span id="20">20</span>
<span id="21">21</span>
<span id="22">22</span>
<span id="23">23</span>
<span id="24">24</span>
<span id="25">25</span>
<span id="26">26</span>
<span id="27">27</span>
<span id="28">28</span>
<span id="29">29</span>
<span id="30">30</span>
<span id="31">31</span>
<span id="32">32</span>
<span id="33">33</span>
<span id="34">34</span>
<span id="35">35</span>
<span id="36">36</span>
<span id="37">37</span>
<span id="38">38</span>
<span id="39">39</span>
<span id="40">40</span>
<span id="41">41</span>
<span id="42">42</span>
<span id="43">43</span>
<span id="44">44</span>
<span id="45">45</span>
<span id="46">46</span>
<span id="47">47</span>
<span id="48">48</span>
<span id="49">49</span>
<span id="50">50</span>
<span id="51">51</span>
<span id="52">52</span>
<span id="53">53</span>
<span id="54">54</span>
<span id="55">55</span>
<span id="56">56</span>
<span id="57">57</span>
<span id="58">58</span>
<span id="59">59</span>
<span id="60">60</span>
<span id="61">61</span>
<span id="62">62</span>
<span id="63">63</span>
<span id="64">64</span>
<span id="65">65</span>
<span id="66">66</span>
<span id="67">67</span>
<span id="68">68</span>
<span id="69">69</span>
<span id="70">70</span>
<span id="71">71</span>
<span id="72">72</span>
<span id="73">73</span>
<span id="74">74</span>
<span id="75">75</span>
<span id="76">76</span>
<span id="77">77</span>
<span id="78">78</span>
<span id="79">79</span>
<span id="80">80</span>
<span id="81">81</span>
<span id="82">82</span>
<span id="83">83</span>
<span id="84">84</span>
</pre><pre class="rust"><code><span class="doccomment">//! Parallel iterator types for [standard collections][std::collections]
//!
//! You will rarely need to interact with this module directly unless you need
//! to name one of the iterator types.
//!
//! [std::collections]: https://doc.rust-lang.org/stable/std/collections/
/// Convert an iterable collection into a parallel iterator by first
/// collecting into a temporary `Vec`, then iterating that.
</span><span class="macro">macro_rules! </span>into_par_vec {
(<span class="macro-nonterminal">$t</span>:ty =&gt; <span class="macro-nonterminal">$iter</span>:ident&lt;$(<span class="macro-nonterminal">$i</span>:tt),<span class="kw-2">*</span>&gt;, <span class="kw">impl </span>$(<span class="macro-nonterminal">$args</span>:tt)<span class="kw-2">*</span>) =&gt; {
<span class="kw">impl </span>$(<span class="macro-nonterminal">$args</span>)* IntoParallelIterator <span class="kw">for </span><span class="macro-nonterminal">$t </span>{
<span class="kw">type </span>Item = &lt;<span class="macro-nonterminal">$t </span><span class="kw">as </span>IntoIterator&gt;::Item;
<span class="kw">type </span>Iter = <span class="macro-nonterminal">$iter</span>&lt;$(<span class="macro-nonterminal">$i</span>),<span class="kw-2">*</span>&gt;;
<span class="kw">fn </span>into_par_iter(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Iter {
<span class="kw">use </span>std::iter::FromIterator;
<span class="macro-nonterminal">$iter </span>{ inner: Vec::from_iter(<span class="self">self</span>).into_par_iter() }
}
}
};
}
<span class="kw">pub mod </span>binary_heap;
<span class="kw">pub mod </span>btree_map;
<span class="kw">pub mod </span>btree_set;
<span class="kw">pub mod </span>hash_map;
<span class="kw">pub mod </span>hash_set;
<span class="kw">pub mod </span>linked_list;
<span class="kw">pub mod </span>vec_deque;
<span class="kw">use </span><span class="self">self</span>::drain_guard::DrainGuard;
<span class="kw">mod </span>drain_guard {
<span class="kw">use </span><span class="kw">crate</span>::iter::ParallelDrainRange;
<span class="kw">use </span>std::mem;
<span class="kw">use </span>std::ops::RangeBounds;
<span class="doccomment">/// A proxy for draining a collection by converting to a `Vec` and back.
///
/// This is used for draining `BinaryHeap` and `VecDeque`, which both have
/// zero-allocation conversions to/from `Vec`, though not zero-cost:
/// - `BinaryHeap` will heapify from `Vec`, but at least that will be empty.
/// - `VecDeque` has to shift items to offset 0 when converting to `Vec`.
</span><span class="attribute">#[allow(missing_debug_implementations)]
</span><span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">struct </span>DrainGuard&lt;<span class="lifetime">&#39;a</span>, T, C: From&lt;Vec&lt;T&gt;&gt;&gt; {
collection: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>C,
vec: Vec&lt;T&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T, C&gt; DrainGuard&lt;<span class="lifetime">&#39;a</span>, T, C&gt;
<span class="kw">where
</span>C: Default + From&lt;Vec&lt;T&gt;&gt;,
Vec&lt;T&gt;: From&lt;C&gt;,
{
<span class="kw">pub</span>(<span class="kw">super</span>) <span class="kw">fn </span>new(collection: <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>C) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
<span class="comment">// Temporarily steal the inner `Vec` so we can drain in place.
</span>vec: Vec::from(mem::take(collection)),
collection,
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T, C: From&lt;Vec&lt;T&gt;&gt;&gt; Drop <span class="kw">for </span>DrainGuard&lt;<span class="lifetime">&#39;a</span>, T, C&gt; {
<span class="kw">fn </span>drop(<span class="kw-2">&amp;mut </span><span class="self">self</span>) {
<span class="comment">// Restore the collection from the `Vec` with its original capacity.
</span><span class="kw-2">*</span><span class="self">self</span>.collection = C::from(mem::take(<span class="kw-2">&amp;mut </span><span class="self">self</span>.vec));
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T, C&gt; ParallelDrainRange&lt;usize&gt; <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>DrainGuard&lt;<span class="lifetime">&#39;_</span>, T, C&gt;
<span class="kw">where
</span>T: Send,
C: From&lt;Vec&lt;T&gt;&gt;,
{
<span class="kw">type </span>Iter = <span class="kw">crate</span>::vec::Drain&lt;<span class="lifetime">&#39;a</span>, T&gt;;
<span class="kw">type </span>Item = T;
<span class="kw">fn </span>par_drain&lt;R: RangeBounds&lt;usize&gt;&gt;(<span class="self">self</span>, range: R) -&gt; <span class="self">Self</span>::Iter {
<span class="self">self</span>.vec.par_drain(range)
}
}
}
</code></pre></div>
</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>