blob: 4dba4d7b5befae4019d53d5aa6c5d337ac07e92b [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/future/try_join.rs`."><meta name="keywords" content="rust, rustlang, rust-lang"><title>try_join.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>
<span id="245">245</span>
<span id="246">246</span>
<span id="247">247</span>
<span id="248">248</span>
<span id="249">249</span>
<span id="250">250</span>
<span id="251">251</span>
<span id="252">252</span>
<span id="253">253</span>
<span id="254">254</span>
<span id="255">255</span>
<span id="256">256</span>
</pre><pre class="rust"><code><span class="attribute">#![allow(non_snake_case)]
</span><span class="kw">use </span><span class="kw">crate</span>::future::{assert_future, try_maybe_done, TryMaybeDone};
<span class="kw">use </span>core::fmt;
<span class="kw">use </span>core::pin::Pin;
<span class="kw">use </span>futures_core::future::{Future, TryFuture};
<span class="kw">use </span>futures_core::task::{Context, Poll};
<span class="kw">use </span>pin_project_lite::pin_project;
<span class="macro">macro_rules! </span>generate {
($(
$(<span class="attribute">#[<span class="macro-nonterminal">$doc</span>:meta]</span>)*
(<span class="macro-nonterminal">$Join</span>:ident, &lt;Fut1, $(<span class="macro-nonterminal">$Fut</span>:ident),<span class="kw-2">*</span>&gt;),
)<span class="kw-2">*</span>) =&gt; ($(
<span class="macro">pin_project! </span>{
$(<span class="attribute">#[<span class="macro-nonterminal">$doc</span>]</span>)*
<span class="attribute">#[must_use = <span class="string">&quot;futures do nothing unless you `.await` or poll them&quot;</span>]
</span><span class="kw">pub struct </span><span class="macro-nonterminal">$Join</span>&lt;Fut1: TryFuture, $(<span class="macro-nonterminal">$Fut</span>: TryFuture),<span class="kw-2">*</span>&gt; {
<span class="attribute">#[pin] </span>Fut1: TryMaybeDone&lt;Fut1&gt;,
$(<span class="attribute">#[pin] </span><span class="macro-nonterminal">$Fut</span>: TryMaybeDone&lt;<span class="macro-nonterminal">$Fut</span>&gt;,)*
}
}
<span class="kw">impl</span>&lt;Fut1, $(<span class="macro-nonterminal">$Fut</span>),<span class="kw-2">*</span>&gt; fmt::Debug <span class="kw">for </span><span class="macro-nonterminal">$Join</span>&lt;Fut1, $(<span class="macro-nonterminal">$Fut</span>),<span class="kw-2">*</span>&gt;
<span class="kw">where
</span>Fut1: TryFuture + fmt::Debug,
Fut1::Ok: fmt::Debug,
Fut1::Error: fmt::Debug,
$(
<span class="macro-nonterminal">$Fut</span>: TryFuture + fmt::Debug,
<span class="macro-nonterminal">$Fut::Ok</span>: fmt::Debug,
<span class="macro-nonterminal">$Fut::Error</span>: fmt::Debug,
)*
{
<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 {
f.debug_struct(<span class="macro">stringify!</span>(<span class="macro-nonterminal">$Join</span>))
.field(<span class="string">&quot;Fut1&quot;</span>, <span class="kw-2">&amp;</span><span class="self">self</span>.Fut1)
$(.field(<span class="macro">stringify!</span>(<span class="macro-nonterminal">$Fut</span>), <span class="kw-2">&amp;</span><span class="self">self</span>.<span class="macro-nonterminal">$Fut</span>))*
.finish()
}
}
<span class="kw">impl</span>&lt;Fut1, $(<span class="macro-nonterminal">$Fut</span>),<span class="kw-2">*</span>&gt; <span class="macro-nonterminal">$Join</span>&lt;Fut1, $(<span class="macro-nonterminal">$Fut</span>),<span class="kw-2">*</span>&gt;
<span class="kw">where
</span>Fut1: TryFuture,
$(
<span class="macro-nonterminal">$Fut</span>: TryFuture&lt;Error=Fut1::Error&gt;
),*
{
<span class="kw">fn </span>new(Fut1: Fut1, $(<span class="macro-nonterminal">$Fut</span>: <span class="macro-nonterminal">$Fut</span>),<span class="kw-2">*</span>) -&gt; <span class="self">Self </span>{
<span class="self">Self </span>{
Fut1: try_maybe_done(Fut1),
$(<span class="macro-nonterminal">$Fut</span>: try_maybe_done(<span class="macro-nonterminal">$Fut</span>)),*
}
}
}
<span class="kw">impl</span>&lt;Fut1, $(<span class="macro-nonterminal">$Fut</span>),<span class="kw-2">*</span>&gt; Future <span class="kw">for </span><span class="macro-nonterminal">$Join</span>&lt;Fut1, $(<span class="macro-nonterminal">$Fut</span>),<span class="kw-2">*</span>&gt;
<span class="kw">where
</span>Fut1: TryFuture,
$(
<span class="macro-nonterminal">$Fut</span>: TryFuture&lt;Error=Fut1::Error&gt;
),*
{
<span class="kw">type </span>Output = <span class="prelude-ty">Result</span>&lt;(Fut1::Ok, $(<span class="macro-nonterminal">$Fut::Ok</span>),<span class="kw-2">*</span>), Fut1::Error&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><span class="kw-2">mut </span>all_done = <span class="bool-val">true</span>;
<span class="kw">let </span><span class="kw-2">mut </span>futures = <span class="self">self</span>.project();
all_done &amp;= futures.Fut1.as_mut().poll(cx)<span class="question-mark">?</span>.is_ready();
$(
all_done &amp;= futures.<span class="macro-nonterminal">$Fut</span>.as_mut().poll(cx)<span class="question-mark">?</span>.is_ready();
)*
<span class="kw">if </span>all_done {
Poll::Ready(<span class="prelude-val">Ok</span>((
futures.Fut1.take_output().unwrap(),
$(
futures.<span class="macro-nonterminal">$Fut</span>.take_output().unwrap()
),*
)))
} <span class="kw">else </span>{
Poll::Pending
}
}
}
)<span class="kw-2">*</span>)
}
<span class="macro">generate! </span>{
<span class="doccomment">/// Future for the [`try_join`](try_join()) function.
</span>(TryJoin, &lt;Fut1, Fut2&gt;),
<span class="doccomment">/// Future for the [`try_join3`] function.
</span>(TryJoin3, &lt;Fut1, Fut2, Fut3&gt;),
<span class="doccomment">/// Future for the [`try_join4`] function.
</span>(TryJoin4, &lt;Fut1, Fut2, Fut3, Fut4&gt;),
<span class="doccomment">/// Future for the [`try_join5`] function.
</span>(TryJoin5, &lt;Fut1, Fut2, Fut3, Fut4, Fut5&gt;),
}
<span class="doccomment">/// Joins the result of two futures, waiting for them both to complete or
/// for one to produce an error.
///
/// This function will return a new future which awaits both futures to
/// complete. If successful, the returned future will finish with a tuple of
/// both results. If unsuccessful, it will complete with the first error
/// encountered.
///
/// Note that this function consumes the passed futures and returns a
/// wrapped version of it.
///
/// # Examples
///
/// When used on multiple futures that return [`Ok`], `try_join` will return
/// [`Ok`] of a tuple of the values:
///
/// ```
/// # futures::executor::block_on(async {
/// use futures::future;
///
/// let a = future::ready(Ok::&lt;i32, i32&gt;(1));
/// let b = future::ready(Ok::&lt;i32, i32&gt;(2));
/// let pair = future::try_join(a, b);
///
/// assert_eq!(pair.await, Ok((1, 2)));
/// # });
/// ```
///
/// If one of the futures resolves to an error, `try_join` will return
/// that error:
///
/// ```
/// # futures::executor::block_on(async {
/// use futures::future;
///
/// let a = future::ready(Ok::&lt;i32, i32&gt;(1));
/// let b = future::ready(Err::&lt;i32, i32&gt;(2));
/// let pair = future::try_join(a, b);
///
/// assert_eq!(pair.await, Err(2));
/// # });
/// ```
</span><span class="kw">pub fn </span>try_join&lt;Fut1, Fut2&gt;(future1: Fut1, future2: Fut2) -&gt; TryJoin&lt;Fut1, Fut2&gt;
<span class="kw">where
</span>Fut1: TryFuture,
Fut2: TryFuture&lt;Error = Fut1::Error&gt;,
{
assert_future::&lt;<span class="prelude-ty">Result</span>&lt;(Fut1::Ok, Fut2::Ok), Fut1::Error&gt;, <span class="kw">_</span>&gt;(TryJoin::new(future1, future2))
}
<span class="doccomment">/// Same as [`try_join`](try_join()), but with more futures.
///
/// # Examples
///
/// ```
/// # futures::executor::block_on(async {
/// use futures::future;
///
/// let a = future::ready(Ok::&lt;i32, i32&gt;(1));
/// let b = future::ready(Ok::&lt;i32, i32&gt;(2));
/// let c = future::ready(Ok::&lt;i32, i32&gt;(3));
/// let tuple = future::try_join3(a, b, c);
///
/// assert_eq!(tuple.await, Ok((1, 2, 3)));
/// # });
/// ```
</span><span class="kw">pub fn </span>try_join3&lt;Fut1, Fut2, Fut3&gt;(
future1: Fut1,
future2: Fut2,
future3: Fut3,
) -&gt; TryJoin3&lt;Fut1, Fut2, Fut3&gt;
<span class="kw">where
</span>Fut1: TryFuture,
Fut2: TryFuture&lt;Error = Fut1::Error&gt;,
Fut3: TryFuture&lt;Error = Fut1::Error&gt;,
{
assert_future::&lt;<span class="prelude-ty">Result</span>&lt;(Fut1::Ok, Fut2::Ok, Fut3::Ok), Fut1::Error&gt;, <span class="kw">_</span>&gt;(TryJoin3::new(
future1, future2, future3,
))
}
<span class="doccomment">/// Same as [`try_join`](try_join()), but with more futures.
///
/// # Examples
///
/// ```
/// # futures::executor::block_on(async {
/// use futures::future;
///
/// let a = future::ready(Ok::&lt;i32, i32&gt;(1));
/// let b = future::ready(Ok::&lt;i32, i32&gt;(2));
/// let c = future::ready(Ok::&lt;i32, i32&gt;(3));
/// let d = future::ready(Ok::&lt;i32, i32&gt;(4));
/// let tuple = future::try_join4(a, b, c, d);
///
/// assert_eq!(tuple.await, Ok((1, 2, 3, 4)));
/// # });
/// ```
</span><span class="kw">pub fn </span>try_join4&lt;Fut1, Fut2, Fut3, Fut4&gt;(
future1: Fut1,
future2: Fut2,
future3: Fut3,
future4: Fut4,
) -&gt; TryJoin4&lt;Fut1, Fut2, Fut3, Fut4&gt;
<span class="kw">where
</span>Fut1: TryFuture,
Fut2: TryFuture&lt;Error = Fut1::Error&gt;,
Fut3: TryFuture&lt;Error = Fut1::Error&gt;,
Fut4: TryFuture&lt;Error = Fut1::Error&gt;,
{
assert_future::&lt;<span class="prelude-ty">Result</span>&lt;(Fut1::Ok, Fut2::Ok, Fut3::Ok, Fut4::Ok), Fut1::Error&gt;, <span class="kw">_</span>&gt;(
TryJoin4::new(future1, future2, future3, future4),
)
}
<span class="doccomment">/// Same as [`try_join`](try_join()), but with more futures.
///
/// # Examples
///
/// ```
/// # futures::executor::block_on(async {
/// use futures::future;
///
/// let a = future::ready(Ok::&lt;i32, i32&gt;(1));
/// let b = future::ready(Ok::&lt;i32, i32&gt;(2));
/// let c = future::ready(Ok::&lt;i32, i32&gt;(3));
/// let d = future::ready(Ok::&lt;i32, i32&gt;(4));
/// let e = future::ready(Ok::&lt;i32, i32&gt;(5));
/// let tuple = future::try_join5(a, b, c, d, e);
///
/// assert_eq!(tuple.await, Ok((1, 2, 3, 4, 5)));
/// # });
/// ```
</span><span class="kw">pub fn </span>try_join5&lt;Fut1, Fut2, Fut3, Fut4, Fut5&gt;(
future1: Fut1,
future2: Fut2,
future3: Fut3,
future4: Fut4,
future5: Fut5,
) -&gt; TryJoin5&lt;Fut1, Fut2, Fut3, Fut4, Fut5&gt;
<span class="kw">where
</span>Fut1: TryFuture,
Fut2: TryFuture&lt;Error = Fut1::Error&gt;,
Fut3: TryFuture&lt;Error = Fut1::Error&gt;,
Fut4: TryFuture&lt;Error = Fut1::Error&gt;,
Fut5: TryFuture&lt;Error = Fut1::Error&gt;,
{
assert_future::&lt;<span class="prelude-ty">Result</span>&lt;(Fut1::Ok, Fut2::Ok, Fut3::Ok, Fut4::Ok, Fut5::Ok), Fut1::Error&gt;, <span class="kw">_</span>&gt;(
TryJoin5::new(future1, future2, future3, future4, future5),
)
}
</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>