blob: 0ca604bfe30357ba077ee201681a78397d1ef9d6 [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/result.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>result.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>
<span id="85">85</span>
<span id="86">86</span>
<span id="87">87</span>
<span id="88">88</span>
<span id="89">89</span>
<span id="90">90</span>
<span id="91">91</span>
<span id="92">92</span>
<span id="93">93</span>
<span id="94">94</span>
<span id="95">95</span>
<span id="96">96</span>
<span id="97">97</span>
<span id="98">98</span>
<span id="99">99</span>
<span id="100">100</span>
<span id="101">101</span>
<span id="102">102</span>
<span id="103">103</span>
<span id="104">104</span>
<span id="105">105</span>
<span id="106">106</span>
<span id="107">107</span>
<span id="108">108</span>
<span id="109">109</span>
<span id="110">110</span>
<span id="111">111</span>
<span id="112">112</span>
<span id="113">113</span>
<span id="114">114</span>
<span id="115">115</span>
<span id="116">116</span>
<span id="117">117</span>
<span id="118">118</span>
<span id="119">119</span>
<span id="120">120</span>
<span id="121">121</span>
<span id="122">122</span>
<span id="123">123</span>
<span id="124">124</span>
<span id="125">125</span>
<span id="126">126</span>
<span id="127">127</span>
<span id="128">128</span>
<span id="129">129</span>
<span id="130">130</span>
<span id="131">131</span>
<span id="132">132</span>
</pre><pre class="rust"><code><span class="doccomment">//! Parallel iterator types for [results][std::result]
//!
//! You will rarely need to interact with this module directly unless you need
//! to name one of the iterator types.
//!
//! [std::result]: https://doc.rust-lang.org/stable/std/result/
</span><span class="kw">use </span><span class="kw">crate</span>::iter::plumbing::<span class="kw-2">*</span>;
<span class="kw">use </span><span class="kw">crate</span>::iter::<span class="kw-2">*</span>;
<span class="kw">use </span>std::sync::Mutex;
<span class="kw">use </span><span class="kw">crate</span>::option;
<span class="doccomment">/// Parallel iterator over a result
</span><span class="attribute">#[derive(Debug, Clone)]
</span><span class="kw">pub struct </span>IntoIter&lt;T: Send&gt; {
inner: option::IntoIter&lt;T&gt;,
}
<span class="kw">impl</span>&lt;T: Send, E&gt; IntoParallelIterator <span class="kw">for </span><span class="prelude-ty">Result</span>&lt;T, E&gt; {
<span class="kw">type </span>Item = T;
<span class="kw">type </span>Iter = IntoIter&lt;T&gt;;
<span class="kw">fn </span>into_par_iter(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Iter {
IntoIter {
inner: <span class="self">self</span>.ok().into_par_iter(),
}
}
}
<span class="macro">delegate_indexed_iterator! </span>{
IntoIter&lt;T&gt; =&gt; T,
<span class="kw">impl</span>&lt;T: Send&gt;
}
<span class="doccomment">/// Parallel iterator over an immutable reference to a result
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>Iter&lt;<span class="lifetime">&#39;a</span>, T: Sync&gt; {
inner: option::IntoIter&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>T&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: Sync&gt; Clone <span class="kw">for </span>Iter&lt;<span class="lifetime">&#39;a</span>, T&gt; {
<span class="kw">fn </span>clone(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; <span class="self">Self </span>{
Iter {
inner: <span class="self">self</span>.inner.clone(),
}
}
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: Sync, E&gt; IntoParallelIterator <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="prelude-ty">Result</span>&lt;T, E&gt; {
<span class="kw">type </span>Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>T;
<span class="kw">type </span>Iter = Iter&lt;<span class="lifetime">&#39;a</span>, T&gt;;
<span class="kw">fn </span>into_par_iter(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Iter {
Iter {
inner: <span class="self">self</span>.as_ref().ok().into_par_iter(),
}
}
}
<span class="macro">delegate_indexed_iterator! </span>{
Iter&lt;<span class="lifetime">&#39;a</span>, T&gt; =&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span>T,
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: Sync + <span class="lifetime">&#39;a</span>&gt;
}
<span class="doccomment">/// Parallel iterator over a mutable reference to a result
</span><span class="attribute">#[derive(Debug)]
</span><span class="kw">pub struct </span>IterMut&lt;<span class="lifetime">&#39;a</span>, T: Send&gt; {
inner: option::IntoIter&lt;<span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>T&gt;,
}
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: Send, E&gt; IntoParallelIterator <span class="kw">for </span><span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span><span class="prelude-ty">Result</span>&lt;T, E&gt; {
<span class="kw">type </span>Item = <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>T;
<span class="kw">type </span>Iter = IterMut&lt;<span class="lifetime">&#39;a</span>, T&gt;;
<span class="kw">fn </span>into_par_iter(<span class="self">self</span>) -&gt; <span class="self">Self</span>::Iter {
IterMut {
inner: <span class="self">self</span>.as_mut().ok().into_par_iter(),
}
}
}
<span class="macro">delegate_indexed_iterator! </span>{
IterMut&lt;<span class="lifetime">&#39;a</span>, T&gt; =&gt; <span class="kw-2">&amp;</span><span class="lifetime">&#39;a </span><span class="kw-2">mut </span>T,
<span class="kw">impl</span>&lt;<span class="lifetime">&#39;a</span>, T: Send + <span class="lifetime">&#39;a</span>&gt;
}
<span class="doccomment">/// Collect an arbitrary `Result`-wrapped collection.
///
/// If any item is `Err`, then all previous `Ok` items collected are
/// discarded, and it returns that error. If there are multiple errors, the
/// one returned is not deterministic.
</span><span class="kw">impl</span>&lt;C, T, E&gt; FromParallelIterator&lt;<span class="prelude-ty">Result</span>&lt;T, E&gt;&gt; <span class="kw">for </span><span class="prelude-ty">Result</span>&lt;C, E&gt;
<span class="kw">where
</span>C: FromParallelIterator&lt;T&gt;,
T: Send,
E: Send,
{
<span class="kw">fn </span>from_par_iter&lt;I&gt;(par_iter: I) -&gt; <span class="self">Self
</span><span class="kw">where
</span>I: IntoParallelIterator&lt;Item = <span class="prelude-ty">Result</span>&lt;T, E&gt;&gt;,
{
<span class="kw">fn </span>ok&lt;T, E&gt;(saved: <span class="kw-2">&amp;</span>Mutex&lt;<span class="prelude-ty">Option</span>&lt;E&gt;&gt;) -&gt; <span class="kw">impl </span>Fn(<span class="prelude-ty">Result</span>&lt;T, E&gt;) -&gt; <span class="prelude-ty">Option</span>&lt;T&gt; + <span class="lifetime">&#39;_ </span>{
<span class="kw">move </span>|item| <span class="kw">match </span>item {
<span class="prelude-val">Ok</span>(item) =&gt; <span class="prelude-val">Some</span>(item),
<span class="prelude-val">Err</span>(error) =&gt; {
<span class="comment">// We don&#39;t need a blocking `lock()`, as anybody
// else holding the lock will also be writing
// `Some(error)`, and then ours is irrelevant.
</span><span class="kw">if let </span><span class="prelude-val">Ok</span>(<span class="kw-2">mut </span>guard) = saved.try_lock() {
<span class="kw">if </span>guard.is_none() {
<span class="kw-2">*</span>guard = <span class="prelude-val">Some</span>(error);
}
}
<span class="prelude-val">None
</span>}
}
}
<span class="kw">let </span>saved_error = Mutex::new(<span class="prelude-val">None</span>);
<span class="kw">let </span>collection = par_iter
.into_par_iter()
.map(ok(<span class="kw-2">&amp;</span>saved_error))
.while_some()
.collect();
<span class="kw">match </span>saved_error.into_inner().unwrap() {
<span class="prelude-val">Some</span>(error) =&gt; <span class="prelude-val">Err</span>(error),
<span class="prelude-val">None </span>=&gt; <span class="prelude-val">Ok</span>(collection),
}
}
}
</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>