blob: 72cb95855d6372e2f78a860a9c30f4143d10334d [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/registry/src/github.com-1ecc6299db9ec823/futures-util-0.3.28/src/stream/try_stream/try_flatten_unordered.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>try_flatten_unordered.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="../../../../futures_util/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="../../../../futures_util/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>
<span id="133">133</span>
<span id="134">134</span>
<span id="135">135</span>
<span id="136">136</span>
<span id="137">137</span>
<span id="138">138</span>
<span id="139">139</span>
<span id="140">140</span>
<span id="141">141</span>
<span id="142">142</span>
<span id="143">143</span>
<span id="144">144</span>
<span id="145">145</span>
<span id="146">146</span>
<span id="147">147</span>
<span id="148">148</span>
<span id="149">149</span>
<span id="150">150</span>
<span id="151">151</span>
<span id="152">152</span>
<span id="153">153</span>
<span id="154">154</span>
<span id="155">155</span>
<span id="156">156</span>
<span id="157">157</span>
<span id="158">158</span>
<span id="159">159</span>
<span id="160">160</span>
<span id="161">161</span>
<span id="162">162</span>
<span id="163">163</span>
<span id="164">164</span>
<span id="165">165</span>
<span id="166">166</span>
<span id="167">167</span>
<span id="168">168</span>
<span id="169">169</span>
<span id="170">170</span>
<span id="171">171</span>
<span id="172">172</span>
<span id="173">173</span>
<span id="174">174</span>
<span id="175">175</span>
<span id="176">176</span>
</pre><pre class="rust"><code><span class="kw">use </span>core::marker::PhantomData;
<span class="kw">use </span>core::pin::Pin;
<span class="kw">use </span>futures_core::ready;
<span class="kw">use </span>futures_core::stream::{FusedStream, Stream, TryStream};
<span class="kw">use </span>futures_core::task::{Context, Poll};
<span class="attribute">#[cfg(feature = <span class="string">&quot;sink&quot;</span>)]
</span><span class="kw">use </span>futures_sink::Sink;
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="kw">use </span><span class="kw">crate</span>::future::Either;
<span class="kw">use </span><span class="kw">crate</span>::stream::stream::flatten_unordered::{
FlattenUnorderedWithFlowController, FlowController, FlowStep,
};
<span class="kw">use </span><span class="kw">crate</span>::stream::IntoStream;
<span class="kw">use </span><span class="kw">crate</span>::TryStreamExt;
<span class="macro">delegate_all!</span>(
<span class="doccomment">/// Stream for the [`try_flatten_unordered`](super::TryStreamExt::try_flatten_unordered) method.
</span>TryFlattenUnordered&lt;St&gt;(
FlattenUnorderedWithFlowController&lt;NestedTryStreamIntoEitherTryStream&lt;St&gt;, PropagateBaseStreamError&lt;St&gt;&gt;
): Debug + Sink + Stream + FusedStream + AccessInner[St, (. .)]
+ New[
|stream: St, limit: <span class="kw">impl </span>Into&lt;<span class="prelude-ty">Option</span>&lt;usize&gt;&gt;|
FlattenUnorderedWithFlowController::new(
NestedTryStreamIntoEitherTryStream::new(stream),
limit.into()
)
]
<span class="kw">where
</span>St: TryStream,
St::Ok: TryStream,
St::Ok: Unpin,
&lt;St::Ok <span class="kw">as </span>TryStream&gt;::Error: From&lt;St::Error&gt;
);
<span class="macro">pin_project! </span>{
<span class="doccomment">/// Emits either successful streams or single-item streams containing the underlying errors.
/// This&#39;s a wrapper for `FlattenUnordered` to reuse its logic over `TryStream`.
</span><span class="attribute">#[derive(Debug)]
#[must_use = <span class="string">&quot;streams do nothing unless polled&quot;</span>]
</span><span class="kw">pub struct </span>NestedTryStreamIntoEitherTryStream&lt;St&gt;
<span class="kw">where
</span>St: TryStream,
St::Ok: TryStream,
St::Ok: Unpin,
&lt;St::Ok <span class="kw">as </span>TryStream&gt;::Error: From&lt;St::Error&gt;
{
<span class="attribute">#[pin]
</span>stream: St
}
}
<span class="kw">impl</span>&lt;St&gt; NestedTryStreamIntoEitherTryStream&lt;St&gt;
<span class="kw">where
</span>St: TryStream,
St::Ok: TryStream + Unpin,
&lt;St::Ok <span class="kw">as </span>TryStream&gt;::Error: From&lt;St::Error&gt;,
{
<span class="kw">fn </span>new(stream: St) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{ stream }
}
<span class="macro">delegate_access_inner!</span>(stream, St, ());
}
<span class="doccomment">/// Emits a single item immediately, then stream will be terminated.
</span><span class="attribute">#[derive(Debug, Clone)]
</span><span class="kw">pub struct </span>Single&lt;T&gt;(<span class="prelude-ty">Option</span>&lt;T&gt;);
<span class="kw">impl</span>&lt;T&gt; Single&lt;T&gt; {
<span class="doccomment">/// Constructs new `Single` with the given value.
</span><span class="kw">fn </span>new(val: T) -&gt; <span class="self">Self </span>{
<span class="self">Self</span>(<span class="prelude-val">Some</span>(val))
}
<span class="doccomment">/// Attempts to take inner item immediately. Will always succeed if the stream isn&#39;t terminated.
</span><span class="kw">fn </span>next_immediate(<span class="kw-2">&amp;mut </span><span class="self">self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;T&gt; {
<span class="self">self</span>.<span class="number">0</span>.take()
}
}
<span class="kw">impl</span>&lt;T&gt; Unpin <span class="kw">for </span>Single&lt;T&gt; {}
<span class="kw">impl</span>&lt;T&gt; Stream <span class="kw">for </span>Single&lt;T&gt; {
<span class="kw">type </span>Item = T;
<span class="kw">fn </span>poll_next(<span class="kw-2">mut </span><span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, <span class="kw">_</span>: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt;&gt; {
Poll::Ready(<span class="self">self</span>.<span class="number">0</span>.take())
}
<span class="kw">fn </span>size_hint(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; (usize, <span class="prelude-ty">Option</span>&lt;usize&gt;) {
<span class="self">self</span>.<span class="number">0</span>.as_ref().map_or((<span class="number">0</span>, <span class="prelude-val">Some</span>(<span class="number">0</span>)), |<span class="kw">_</span>| (<span class="number">1</span>, <span class="prelude-val">Some</span>(<span class="number">1</span>)))
}
}
<span class="doccomment">/// Immediately propagates errors occurred in the base stream.
</span><span class="attribute">#[derive(Debug, Clone, Copy)]
</span><span class="kw">pub struct </span>PropagateBaseStreamError&lt;St&gt;(PhantomData&lt;St&gt;);
<span class="kw">type </span>BaseStreamItem&lt;St&gt; = &lt;NestedTryStreamIntoEitherTryStream&lt;St&gt; <span class="kw">as </span>Stream&gt;::Item;
<span class="kw">type </span>InnerStreamItem&lt;St&gt; = &lt;BaseStreamItem&lt;St&gt; <span class="kw">as </span>Stream&gt;::Item;
<span class="kw">impl</span>&lt;St&gt; FlowController&lt;BaseStreamItem&lt;St&gt;, InnerStreamItem&lt;St&gt;&gt; <span class="kw">for </span>PropagateBaseStreamError&lt;St&gt;
<span class="kw">where
</span>St: TryStream,
St::Ok: TryStream + Unpin,
&lt;St::Ok <span class="kw">as </span>TryStream&gt;::Error: From&lt;St::Error&gt;,
{
<span class="kw">fn </span>next_step(item: BaseStreamItem&lt;St&gt;) -&gt; FlowStep&lt;BaseStreamItem&lt;St&gt;, InnerStreamItem&lt;St&gt;&gt; {
<span class="kw">match </span>item {
<span class="comment">// A new successful inner stream received
</span>st @ Either::Left(<span class="kw">_</span>) =&gt; FlowStep::Continue(st),
<span class="comment">// An error encountered
</span>Either::Right(<span class="kw-2">mut </span>err) =&gt; FlowStep::Return(err.next_immediate().unwrap()),
}
}
}
<span class="kw">type </span>SingleStreamResult&lt;St&gt; = Single&lt;<span class="prelude-ty">Result</span>&lt;&lt;St <span class="kw">as </span>TryStream&gt;::Ok, &lt;St <span class="kw">as </span>TryStream&gt;::Error&gt;&gt;;
<span class="kw">impl</span>&lt;St&gt; Stream <span class="kw">for </span>NestedTryStreamIntoEitherTryStream&lt;St&gt;
<span class="kw">where
</span>St: TryStream,
St::Ok: TryStream + Unpin,
&lt;St::Ok <span class="kw">as </span>TryStream&gt;::Error: From&lt;St::Error&gt;,
{
<span class="comment">// Item is either an inner stream or a stream containing a single error.
// This will allow using `Either`&#39;s `Stream` implementation as both branches are actually streams of `Result`&#39;s.
</span><span class="kw">type </span>Item = Either&lt;IntoStream&lt;St::Ok&gt;, SingleStreamResult&lt;St::Ok&gt;&gt;;
<span class="kw">fn </span>poll_next(<span class="self">self</span>: Pin&lt;<span class="kw-2">&amp;mut </span><span class="self">Self</span>&gt;, cx: <span class="kw-2">&amp;mut </span>Context&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; Poll&lt;<span class="prelude-ty">Option</span>&lt;<span class="self">Self</span>::Item&gt;&gt; {
<span class="kw">let </span>item = <span class="macro">ready!</span>(<span class="self">self</span>.project().stream.try_poll_next(cx));
<span class="kw">let </span>out = <span class="kw">match </span>item {
<span class="prelude-val">Some</span>(res) =&gt; <span class="kw">match </span>res {
<span class="comment">// Emit successful inner stream as is
</span><span class="prelude-val">Ok</span>(stream) =&gt; Either::Left(stream.into_stream()),
<span class="comment">// Wrap an error into a stream containing a single item
</span>err @ <span class="prelude-val">Err</span>(<span class="kw">_</span>) =&gt; {
<span class="kw">let </span>res = err.map(|<span class="kw">_</span>: St::Ok| <span class="macro">unreachable!</span>()).map_err(Into::into);
Either::Right(Single::new(res))
}
},
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span>Poll::Ready(<span class="prelude-val">None</span>),
};
Poll::Ready(<span class="prelude-val">Some</span>(out))
}
}
<span class="kw">impl</span>&lt;St&gt; FusedStream <span class="kw">for </span>NestedTryStreamIntoEitherTryStream&lt;St&gt;
<span class="kw">where
</span>St: TryStream + FusedStream,
St::Ok: TryStream + Unpin,
&lt;St::Ok <span class="kw">as </span>TryStream&gt;::Error: From&lt;St::Error&gt;,
{
<span class="kw">fn </span>is_terminated(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.stream.is_terminated()
}
}
<span class="comment">// Forwarding impl of Sink from the underlying stream
</span><span class="attribute">#[cfg(feature = <span class="string">&quot;sink&quot;</span>)]
</span><span class="kw">impl</span>&lt;St, Item&gt; Sink&lt;Item&gt; <span class="kw">for </span>NestedTryStreamIntoEitherTryStream&lt;St&gt;
<span class="kw">where
</span>St: TryStream + Sink&lt;Item&gt;,
St::Ok: TryStream + Unpin,
&lt;St::Ok <span class="kw">as </span>TryStream&gt;::Error: From&lt;&lt;St <span class="kw">as </span>TryStream&gt;::Error&gt;,
{
<span class="kw">type </span>Error = &lt;St <span class="kw">as </span>Sink&lt;Item&gt;&gt;::Error;
<span class="macro">delegate_sink!</span>(stream, Item);
}
</code></pre></div>
</section></div></main><div id="rustdoc-vars" data-root-path="../../../../" data-current-crate="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html>