blob: b001589393be7570210f029d0312ab59e10560ce [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/futures_ordered.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>futures_ordered.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>
<span id="177">177</span>
<span id="178">178</span>
<span id="179">179</span>
<span id="180">180</span>
<span id="181">181</span>
<span id="182">182</span>
<span id="183">183</span>
<span id="184">184</span>
<span id="185">185</span>
<span id="186">186</span>
<span id="187">187</span>
<span id="188">188</span>
<span id="189">189</span>
<span id="190">190</span>
<span id="191">191</span>
<span id="192">192</span>
<span id="193">193</span>
<span id="194">194</span>
<span id="195">195</span>
<span id="196">196</span>
<span id="197">197</span>
<span id="198">198</span>
<span id="199">199</span>
<span id="200">200</span>
<span id="201">201</span>
<span id="202">202</span>
<span id="203">203</span>
<span id="204">204</span>
<span id="205">205</span>
<span id="206">206</span>
<span id="207">207</span>
<span id="208">208</span>
<span id="209">209</span>
<span id="210">210</span>
<span id="211">211</span>
<span id="212">212</span>
<span id="213">213</span>
<span id="214">214</span>
<span id="215">215</span>
<span id="216">216</span>
<span id="217">217</span>
<span id="218">218</span>
<span id="219">219</span>
<span id="220">220</span>
<span id="221">221</span>
<span id="222">222</span>
<span id="223">223</span>
<span id="224">224</span>
<span id="225">225</span>
<span id="226">226</span>
<span id="227">227</span>
<span id="228">228</span>
<span id="229">229</span>
<span id="230">230</span>
<span id="231">231</span>
<span id="232">232</span>
<span id="233">233</span>
<span id="234">234</span>
<span id="235">235</span>
<span id="236">236</span>
<span id="237">237</span>
<span id="238">238</span>
<span id="239">239</span>
<span id="240">240</span>
<span id="241">241</span>
<span id="242">242</span>
<span id="243">243</span>
<span id="244">244</span>
</pre><pre class="rust"><code><span class="kw">use </span><span class="kw">crate</span>::stream::{FuturesUnordered, StreamExt};
<span class="kw">use </span>alloc::collections::binary_heap::{BinaryHeap, PeekMut};
<span class="kw">use </span>core::cmp::Ordering;
<span class="kw">use </span>core::fmt::{<span class="self">self</span>, Debug};
<span class="kw">use </span>core::iter::FromIterator;
<span class="kw">use </span>core::pin::Pin;
<span class="kw">use </span>futures_core::future::Future;
<span class="kw">use </span>futures_core::ready;
<span class="kw">use </span>futures_core::stream::Stream;
<span class="kw">use </span>futures_core::{
task::{Context, Poll},
FusedStream,
};
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">pin_project! </span>{
<span class="attribute">#[must_use = <span class="string">&quot;futures do nothing unless you `.await` or poll them&quot;</span>]
#[derive(Debug)]
</span><span class="kw">struct </span>OrderWrapper&lt;T&gt; {
<span class="attribute">#[pin]
</span>data: T, <span class="comment">// A future or a future&#39;s output
</span>index: isize,
}
}
<span class="kw">impl</span>&lt;T&gt; PartialEq <span class="kw">for </span>OrderWrapper&lt;T&gt; {
<span class="kw">fn </span>eq(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span><span class="self">Self</span>) -&gt; bool {
<span class="self">self</span>.index == other.index
}
}
<span class="kw">impl</span>&lt;T&gt; Eq <span class="kw">for </span>OrderWrapper&lt;T&gt; {}
<span class="kw">impl</span>&lt;T&gt; PartialOrd <span class="kw">for </span>OrderWrapper&lt;T&gt; {
<span class="kw">fn </span>partial_cmp(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span><span class="self">Self</span>) -&gt; <span class="prelude-ty">Option</span>&lt;Ordering&gt; {
<span class="prelude-val">Some</span>(<span class="self">self</span>.cmp(other))
}
}
<span class="kw">impl</span>&lt;T&gt; Ord <span class="kw">for </span>OrderWrapper&lt;T&gt; {
<span class="kw">fn </span>cmp(<span class="kw-2">&amp;</span><span class="self">self</span>, other: <span class="kw-2">&amp;</span><span class="self">Self</span>) -&gt; Ordering {
<span class="comment">// BinaryHeap is a max heap, so compare backwards here.
</span>other.index.cmp(<span class="kw-2">&amp;</span><span class="self">self</span>.index)
}
}
<span class="kw">impl</span>&lt;T&gt; Future <span class="kw">for </span>OrderWrapper&lt;T&gt;
<span class="kw">where
</span>T: Future,
{
<span class="kw">type </span>Output = OrderWrapper&lt;T::Output&gt;;
<span class="kw">fn </span>poll(<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="self">Self</span>::Output&gt; {
<span class="kw">let </span>index = <span class="self">self</span>.index;
<span class="self">self</span>.project().data.poll(cx).map(|output| OrderWrapper { data: output, index })
}
}
<span class="doccomment">/// An unbounded queue of futures.
///
/// This &quot;combinator&quot; is similar to [`FuturesUnordered`], but it imposes a FIFO order
/// on top of the set of futures. While futures in the set will race to
/// completion in parallel, results will only be returned in the order their
/// originating futures were added to the queue.
///
/// Futures are pushed into this queue and their realized values are yielded in
/// order. This structure is optimized to manage a large number of futures.
/// Futures managed by `FuturesOrdered` will only be polled when they generate
/// notifications. This reduces the required amount of work needed to coordinate
/// large numbers of futures.
///
/// When a `FuturesOrdered` is first created, it does not contain any futures.
/// Calling `poll` in this state will result in `Poll::Ready(None))` to be
/// returned. Futures are submitted to the queue using `push`; however, the
/// future will **not** be polled at this point. `FuturesOrdered` will only
/// poll managed futures when `FuturesOrdered::poll` is called. As such, it
/// is important to call `poll` after pushing new futures.
///
/// If `FuturesOrdered::poll` returns `Poll::Ready(None)` this means that
/// the queue is currently not managing any futures. A future may be submitted
/// to the queue at a later time. At that point, a call to
/// `FuturesOrdered::poll` will either return the future&#39;s resolved value
/// **or** `Poll::Pending` if the future has not yet completed. When
/// multiple futures are submitted to the queue, `FuturesOrdered::poll` will
/// return `Poll::Pending` until the first future completes, even if
/// some of the later futures have already completed.
///
/// Note that you can create a ready-made `FuturesOrdered` via the
/// [`collect`](Iterator::collect) method, or you can start with an empty queue
/// with the `FuturesOrdered::new` constructor.
///
/// This type is only available when the `std` or `alloc` feature of this
/// library is activated, and it is activated by default.
</span><span class="attribute">#[must_use = <span class="string">&quot;streams do nothing unless polled&quot;</span>]
</span><span class="kw">pub struct </span>FuturesOrdered&lt;T: Future&gt; {
in_progress_queue: FuturesUnordered&lt;OrderWrapper&lt;T&gt;&gt;,
queued_outputs: BinaryHeap&lt;OrderWrapper&lt;T::Output&gt;&gt;,
next_incoming_index: isize,
next_outgoing_index: isize,
}
<span class="kw">impl</span>&lt;T: Future&gt; Unpin <span class="kw">for </span>FuturesOrdered&lt;T&gt; {}
<span class="kw">impl</span>&lt;Fut: Future&gt; FuturesOrdered&lt;Fut&gt; {
<span class="doccomment">/// Constructs a new, empty `FuturesOrdered`
///
/// The returned `FuturesOrdered` does not contain any futures and, in this
/// state, `FuturesOrdered::poll_next` will return `Poll::Ready(None)`.
</span><span class="kw">pub fn </span>new() -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
in_progress_queue: FuturesUnordered::new(),
queued_outputs: BinaryHeap::new(),
next_incoming_index: <span class="number">0</span>,
next_outgoing_index: <span class="number">0</span>,
}
}
<span class="doccomment">/// Returns the number of futures contained in the queue.
///
/// This represents the total number of in-flight futures, both
/// those currently processing and those that have completed but
/// which are waiting for earlier futures to complete.
</span><span class="kw">pub fn </span>len(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; usize {
<span class="self">self</span>.in_progress_queue.len() + <span class="self">self</span>.queued_outputs.len()
}
<span class="doccomment">/// Returns `true` if the queue contains no futures
</span><span class="kw">pub fn </span>is_empty(<span class="kw-2">&amp;</span><span class="self">self</span>) -&gt; bool {
<span class="self">self</span>.in_progress_queue.is_empty() &amp;&amp; <span class="self">self</span>.queued_outputs.is_empty()
}
<span class="doccomment">/// Push a future into the queue.
///
/// This function submits the given future to the internal set for managing.
/// This function will not call `poll` on the submitted future. The caller
/// must ensure that `FuturesOrdered::poll` is called in order to receive
/// task notifications.
</span><span class="attribute">#[deprecated(note = <span class="string">&quot;use `push_back` instead&quot;</span>)]
</span><span class="kw">pub fn </span>push(<span class="kw-2">&amp;mut </span><span class="self">self</span>, future: Fut) {
<span class="self">self</span>.push_back(future);
}
<span class="doccomment">/// Pushes a future to the back of the queue.
///
/// This function submits the given future to the internal set for managing.
/// This function will not call `poll` on the submitted future. The caller
/// must ensure that `FuturesOrdered::poll` is called in order to receive
/// task notifications.
</span><span class="kw">pub fn </span>push_back(<span class="kw-2">&amp;mut </span><span class="self">self</span>, future: Fut) {
<span class="kw">let </span>wrapped = OrderWrapper { data: future, index: <span class="self">self</span>.next_incoming_index };
<span class="self">self</span>.next_incoming_index += <span class="number">1</span>;
<span class="self">self</span>.in_progress_queue.push(wrapped);
}
<span class="doccomment">/// Pushes a future to the front of the queue.
///
/// This function submits the given future to the internal set for managing.
/// This function will not call `poll` on the submitted future. The caller
/// must ensure that `FuturesOrdered::poll` is called in order to receive
/// task notifications. This future will be the next future to be returned
/// complete.
</span><span class="kw">pub fn </span>push_front(<span class="kw-2">&amp;mut </span><span class="self">self</span>, future: Fut) {
<span class="kw">let </span>wrapped = OrderWrapper { data: future, index: <span class="self">self</span>.next_outgoing_index - <span class="number">1 </span>};
<span class="self">self</span>.next_outgoing_index -= <span class="number">1</span>;
<span class="self">self</span>.in_progress_queue.push(wrapped);
}
}
<span class="kw">impl</span>&lt;Fut: Future&gt; Default <span class="kw">for </span>FuturesOrdered&lt;Fut&gt; {
<span class="kw">fn </span>default() -&gt; <span class="self">Self </span>{
<span class="self">Self</span>::new()
}
}
<span class="kw">impl</span>&lt;Fut: Future&gt; Stream <span class="kw">for </span>FuturesOrdered&lt;Fut&gt; {
<span class="kw">type </span>Item = Fut::Output;
<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;, 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>this = <span class="kw-2">&amp;mut *</span><span class="self">self</span>;
<span class="comment">// Check to see if we&#39;ve already received the next value
</span><span class="kw">if let </span><span class="prelude-val">Some</span>(next_output) = this.queued_outputs.peek_mut() {
<span class="kw">if </span>next_output.index == this.next_outgoing_index {
this.next_outgoing_index += <span class="number">1</span>;
<span class="kw">return </span>Poll::Ready(<span class="prelude-val">Some</span>(PeekMut::pop(next_output).data));
}
}
<span class="kw">loop </span>{
<span class="kw">match </span><span class="macro">ready!</span>(this.in_progress_queue.poll_next_unpin(cx)) {
<span class="prelude-val">Some</span>(output) =&gt; {
<span class="kw">if </span>output.index == this.next_outgoing_index {
this.next_outgoing_index += <span class="number">1</span>;
<span class="kw">return </span>Poll::Ready(<span class="prelude-val">Some</span>(output.data));
} <span class="kw">else </span>{
this.queued_outputs.push(output)
}
}
<span class="prelude-val">None </span>=&gt; <span class="kw">return </span>Poll::Ready(<span class="prelude-val">None</span>),
}
}
}
<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="kw">let </span>len = <span class="self">self</span>.len();
(len, <span class="prelude-val">Some</span>(len))
}
}
<span class="kw">impl</span>&lt;Fut: Future&gt; Debug <span class="kw">for </span>FuturesOrdered&lt;Fut&gt; {
<span class="kw">fn </span>fmt(<span class="kw-2">&amp;</span><span class="self">self</span>, f: <span class="kw-2">&amp;mut </span>fmt::Formatter&lt;<span class="lifetime">&#39;_</span>&gt;) -&gt; fmt::Result {
<span class="macro">write!</span>(f, <span class="string">&quot;FuturesOrdered {{ ... }}&quot;</span>)
}
}
<span class="kw">impl</span>&lt;Fut: Future&gt; FromIterator&lt;Fut&gt; <span class="kw">for </span>FuturesOrdered&lt;Fut&gt; {
<span class="kw">fn </span>from_iter&lt;T&gt;(iter: T) -&gt; <span class="self">Self
</span><span class="kw">where
</span>T: IntoIterator&lt;Item = Fut&gt;,
{
<span class="kw">let </span>acc = <span class="self">Self</span>::new();
iter.into_iter().fold(acc, |<span class="kw-2">mut </span>acc, item| {
acc.push_back(item);
acc
})
}
}
<span class="kw">impl</span>&lt;Fut: Future&gt; FusedStream <span class="kw">for </span>FuturesOrdered&lt;Fut&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>.in_progress_queue.is_terminated() &amp;&amp; <span class="self">self</span>.queued_outputs.is_empty()
}
}
<span class="kw">impl</span>&lt;Fut: Future&gt; Extend&lt;Fut&gt; <span class="kw">for </span>FuturesOrdered&lt;Fut&gt; {
<span class="kw">fn </span>extend&lt;I&gt;(<span class="kw-2">&amp;mut </span><span class="self">self</span>, iter: I)
<span class="kw">where
</span>I: IntoIterator&lt;Item = Fut&gt;,
{
<span class="kw">for </span>item <span class="kw">in </span>iter {
<span class="self">self</span>.push_back(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>