mirror of
https://github.com/OMGeeky/google-apis-rs.git
synced 2026-01-30 13:54:09 +01:00
47 lines
9.2 KiB
HTML
47 lines
9.2 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="Creates a future which represents either a collection of the results of the futures given or an error."><title>try_join_all in futures_util::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_util" 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_util/index.html">futures_util</a><span class="version">0.3.28</span></h2></div><div class="sidebar-elems"><h2><a href="index.html">In futures_util::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_util/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_util</a>::<wbr><a href="index.html">future</a>::<wbr><a class="fn" href="#">try_join_all</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_all.rs.html#117-148">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_all<I>(iter: I) -> <a class="struct" href="struct.TryJoinAll.html" title="struct futures_util::future::TryJoinAll">TryJoinAll</a><I::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>> <a href="#" class="tooltip" data-notable-ty="TryJoinAll<I::Item>">ⓘ</a><div class="where">where
|
||
I: <a class="trait" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html" title="trait core::iter::traits::collect::IntoIterator">IntoIterator</a>,
|
||
I::<a class="associatedtype" href="https://doc.rust-lang.org/1.76.0/core/iter/traits/collect/trait.IntoIterator.html#associatedtype.Item" title="type core::iter::traits::collect::IntoIterator::Item">Item</a>: <a class="trait" href="trait.TryFuture.html" title="trait futures_util::future::TryFuture">TryFuture</a>,</div></code></pre><details class="toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>Creates a future which represents either a collection of the results of the
|
||
futures given or an error.</p>
|
||
<p>The returned future will drive execution for all of its underlying futures,
|
||
collecting the results into a destination <code>Vec<T></code> in the same order as they
|
||
were provided.</p>
|
||
<p>If any future returns an error then all other futures will be canceled and
|
||
an error will be returned immediately. If all futures complete successfully,
|
||
however, then the returned future will succeed with a <code>Vec</code> of all the
|
||
successful results.</p>
|
||
<p>This function is only available when the <code>std</code> or <code>alloc</code> feature of this
|
||
library is activated, and it is activated by default.</p>
|
||
<h2 id="see-also"><a href="#see-also">See Also</a></h2>
|
||
<p><code>try_join_all</code> will switch to the more powerful <a href="../stream/struct.FuturesOrdered.html" title="struct futures_util::stream::FuturesOrdered"><code>FuturesOrdered</code></a> for performance
|
||
reasons if the number of futures is large. You may want to look into using it or
|
||
it’s counterpart <a href="../stream/struct.FuturesUnordered.html" title="struct futures_util::stream::FuturesUnordered"><code>FuturesUnordered</code></a> directly.</p>
|
||
<p>Some examples for additional functionality provided by these are:</p>
|
||
<ul>
|
||
<li>
|
||
<p>Adding new futures to the set even after it has been started.</p>
|
||
</li>
|
||
<li>
|
||
<p>Only polling the specific futures that have been woken. In cases where
|
||
you have a lot of futures this will result in much more efficient polling.</p>
|
||
</li>
|
||
</ul>
|
||
<h2 id="examples"><a href="#examples">Examples</a></h2>
|
||
<div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>futures::future::{<span class="self">self</span>, try_join_all};
|
||
|
||
<span class="kw">let </span>futures = <span class="macro">vec!</span>[
|
||
future::ok::<u32, u32>(<span class="number">1</span>),
|
||
future::ok::<u32, u32>(<span class="number">2</span>),
|
||
future::ok::<u32, u32>(<span class="number">3</span>),
|
||
];
|
||
|
||
<span class="macro">assert_eq!</span>(try_join_all(futures).<span class="kw">await</span>, <span class="prelude-val">Ok</span>(<span class="macro">vec!</span>[<span class="number">1</span>, <span class="number">2</span>, <span class="number">3</span>]));
|
||
|
||
<span class="kw">let </span>futures = <span class="macro">vec!</span>[
|
||
future::ok::<u32, u32>(<span class="number">1</span>),
|
||
future::err::<u32, u32>(<span class="number">2</span>),
|
||
future::ok::<u32, u32>(<span class="number">3</span>),
|
||
];
|
||
|
||
<span class="macro">assert_eq!</span>(try_join_all(futures).<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">{"TryJoinAll<I::Item>":"<h3>Notable traits for <code><a class=\"struct\" href=\"struct.TryJoinAll.html\" title=\"struct futures_util::future::TryJoinAll\">TryJoinAll</a><F></code></h3><pre><code><div class=\"where\">impl<F> <a class=\"trait\" href=\"https://doc.rust-lang.org/1.76.0/core/future/future/trait.Future.html\" title=\"trait core::future::future::Future\">Future</a> for <a class=\"struct\" href=\"struct.TryJoinAll.html\" title=\"struct futures_util::future::TryJoinAll\">TryJoinAll</a><F><div class=\"where\">where\n F: <a class=\"trait\" href=\"trait.TryFuture.html\" title=\"trait futures_util::future::TryFuture\">TryFuture</a>,</div></div><div class=\"where\"> type <a href=\"https://doc.rust-lang.org/1.76.0/core/future/future/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><<a class=\"struct\" href=\"https://doc.rust-lang.org/1.76.0/alloc/vec/struct.Vec.html\" title=\"struct alloc::vec::Vec\">Vec</a><F::<a class=\"associatedtype\" href=\"trait.TryFuture.html#associatedtype.Ok\" title=\"type futures_util::future::TryFuture::Ok\">Ok</a>>, F::<a class=\"associatedtype\" href=\"trait.TryFuture.html#associatedtype.Error\" title=\"type futures_util::future::TryFuture::Error\">Error</a>>;</div>"}</script></section></div></main></body></html> |