mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-28 12:51:55 +01:00
33 lines
9.0 KiB
HTML
33 lines
9.0 KiB
HTML
<!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="Joins the result of two futures, waiting for them both to complete or for one to produce an error."><title>try_join in futures::future - Rust</title><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceSerif4-Regular-46f98efaafac5295.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Regular-018c141bf0843ffd.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/FiraSans-Medium-8f9a781e4970d388.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Regular-562dcc5011b6de7d.ttf.woff2"><link rel="preload" as="font" type="font/woff2" crossorigin href="../../static.files/SourceCodePro-Semibold-d899c5a5c4aeb14a.ttf.woff2"><link rel="stylesheet" href="../../static.files/normalize-76eba96aa4d2e634.css"><link rel="stylesheet" href="../../static.files/rustdoc-ac92e1bbe349e143.css"><meta name="rustdoc-vars" data-root-path="../../" data-static-root-path="../../static.files/" data-current-crate="futures" data-themes="" data-resource-suffix="" data-rustdoc-version="1.76.0 (07dca489a 2024-02-04)" data-channel="1.76.0" data-search-js="search-2b6ce74ff89ae146.js" data-settings-js="settings-4313503d2e1961c2.js" ><script src="../../static.files/storage-f2adc0d6ca4d09fb.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-305769736d49e732.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-feafe1bb7466e4bd.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-16x16-8b506e7a72182f1c.png"><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-422f7d1d52889060.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-2c020d218678b618.svg"></head><body class="rustdoc fn"><!--[if lte IE 11]><div class="warning">This old browser is unsupported and will most likely display funky things.</div><![endif]--><nav class="mobile-topbar"><button class="sidebar-menu-toggle">☰</button></nav><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures/index.html">futures</a><span class="version">0.3.28</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In futures::future</a></h2></div></nav><div class="sidebar-resizer"></div>
|
||
<main><div class="width-limiter"><nav class="sub"><form class="search-form"><span></span><div id="sidebar-button" tabindex="-1"><a href="../../futures/all.html" title="show sidebar"></a></div><input class="search-input" name="search" aria-label="Run search in the documentation" autocomplete="off" spellcheck="false" placeholder="Click or press ‘S’ to search, ‘?’ for more options…" type="search"><div id="help-button" tabindex="-1"><a href="../../help.html" title="help">?</a></div><div id="settings-menu" tabindex="-1"><a href="../../settings.html" title="settings"><img width="22" height="22" alt="Change settings" src="../../static.files/wheel-7b819b6101059cd0.svg"></a></div></form></nav><section id="main-content" class="content"><div class="main-heading"><h1>Function <a href="../index.html">futures</a>::<wbr><a href="index.html">future</a>::<wbr><a class="fn" href="#">try_join</a><button id="copy-path" title="Copy item path to clipboard"><img src="../../static.files/clipboard-7571035ce49a181d.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="src" href="../../src/futures_util/future/try_join.rs.html#148-151">source</a> · <button id="toggle-all-docs" title="collapse all docs">[<span>−</span>]</button></span></div><pre class="rust item-decl"><code>pub fn try_join<Fut1, Fut2>(future1: Fut1, future2: Fut2) -> <a class="struct" href="struct.TryJoin.html" title="struct futures::future::TryJoin">TryJoin</a><Fut1, Fut2> <a href="#" class="tooltip" data-notable-ty="TryJoin<Fut1, Fut2>">ⓘ</a><div class="where">where
|
||
Fut1: <a class="trait" href="trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>,
|
||
Fut2: <a class="trait" href="trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a><Error = <Fut1 as <a class="trait" href="trait.TryFuture.html" title="trait futures::future::TryFuture">TryFuture</a>>::<a class="associatedtype" href="trait.TryFuture.html#associatedtype.Error" title="type futures::future::TryFuture::Error">Error</a>>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Joins the result of two futures, waiting for them both to complete or
|
||
for one to produce an error.</p>
|
||
<p>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.</p>
|
||
<p>Note that this function consumes the passed futures and returns a
|
||
wrapped version of it.</p>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<p>When used on multiple futures that return <a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html#variant.Ok" title="variant core::result::Result::Ok"><code>Ok</code></a>, <code>try_join</code> will return
|
||
<a href="https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html#variant.Ok" title="variant core::result::Result::Ok"><code>Ok</code></a> of a tuple of the values:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::future;
|
||
|
||
<span class="kw">let </span>a = future::ready(<span class="prelude-val">Ok</span>::<i32, i32>(<span class="number">1</span>));
|
||
<span class="kw">let </span>b = future::ready(<span class="prelude-val">Ok</span>::<i32, i32>(<span class="number">2</span>));
|
||
<span class="kw">let </span>pair = future::try_join(a, b);
|
||
|
||
<span class="macro">assert_eq!</span>(pair.<span class="kw">await</span>, <span class="prelude-val">Ok</span>((<span class="number">1</span>, <span class="number">2</span>)));</code></pre></div>
|
||
<p>If one of the futures resolves to an error, <code>try_join</code> will return
|
||
that error:</p>
|
||
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::future;
|
||
|
||
<span class="kw">let </span>a = future::ready(<span class="prelude-val">Ok</span>::<i32, i32>(<span class="number">1</span>));
|
||
<span class="kw">let </span>b = future::ready(<span class="prelude-val">Err</span>::<i32, i32>(<span class="number">2</span>));
|
||
<span class="kw">let </span>pair = future::try_join(a, b);
|
||
|
||
<span class="macro">assert_eq!</span>(pair.<span class="kw">await</span>, <span class="prelude-val">Err</span>(<span class="number">2</span>));</code></pre></div>
|
||
</div></details><script type="text/json" id="notable-traits-data">{"TryJoin<Fut1, Fut2>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.TryJoin.html\" title=\"struct futures::future::TryJoin\">TryJoin</a><Fut1, Fut2></code></h3><pre><code><div class=\"where\">impl<Fut1, Fut2> <a class=\"trait\" href=\"trait.Future.html\" title=\"trait futures::future::Future\">Future</a> for <a class=\"struct\" href=\"struct.TryJoin.html\" title=\"struct futures::future::TryJoin\">TryJoin</a><Fut1, Fut2><div class=\"where\">where\n Fut1: <a class=\"trait\" href=\"trait.TryFuture.html\" title=\"trait futures::future::TryFuture\">TryFuture</a>,\n Fut2: <a class=\"trait\" href=\"trait.TryFuture.html\" title=\"trait futures::future::TryFuture\">TryFuture</a><Error = <Fut1 as <a class=\"trait\" href=\"trait.TryFuture.html\" title=\"trait futures::future::TryFuture\">TryFuture</a>>::<a class=\"associatedtype\" href=\"trait.TryFuture.html#associatedtype.Error\" title=\"type futures::future::TryFuture::Error\">Error</a>>,</div></div><div class=\"where\"> type <a href=\"trait.Future.html#associatedtype.Output\" class=\"associatedtype\">Output</a> = <a class=\"enum\" href=\"https://doc.rust-lang.org/1.76.0/core/result/enum.Result.html\" title=\"enum core::result::Result\">Result</a><(<Fut1 as <a class=\"trait\" href=\"trait.TryFuture.html\" title=\"trait futures::future::TryFuture\">TryFuture</a>>::<a class=\"associatedtype\" href=\"trait.TryFuture.html#associatedtype.Ok\" title=\"type futures::future::TryFuture::Ok\">Ok</a>, <Fut2 as <a class=\"trait\" href=\"trait.TryFuture.html\" title=\"trait futures::future::TryFuture\">TryFuture</a>>::<a class=\"associatedtype\" href=\"trait.TryFuture.html#associatedtype.Ok\" title=\"type futures::future::TryFuture::Ok\">Ok</a>), <Fut1 as <a class=\"trait\" href=\"trait.TryFuture.html\" title=\"trait futures::future::TryFuture\">TryFuture</a>>::<a class=\"associatedtype\" href=\"trait.TryFuture.html#associatedtype.Error\" title=\"type futures::future::TryFuture::Error\">Error</a>>;</div>"}</script></section></div></main></body></html> |