45 lines
8.5 KiB
HTML
45 lines
8.5 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><script>if(window.location.protocol!=="file:")document.head.insertAdjacentHTML("beforeend","SourceSerif4-Regular-6b053e98.ttf.woff2,FiraSans-Italic-81dc35de.woff2,FiraSans-Regular-0fe48ade.woff2,FiraSans-MediumItalic-ccf7e434.woff2,FiraSans-Medium-e1aa3f0a.woff2,SourceCodePro-Regular-8badfe75.ttf.woff2,SourceCodePro-Semibold-aa29a496.ttf.woff2".split(",").map(f=>`<link rel="preload" as="font" type="font/woff2"href="../../static.files/${f}">`).join(""))</script><link rel="stylesheet" href="../../static.files/normalize-9960930a.css"><link rel="stylesheet" href="../../static.files/rustdoc-ca0dd0c4.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.93.1 (01f6ddf75 2026-02-11) (Arch Linux rust 1:1.93.1-1)" data-channel="1.93.1" data-search-js="search-9e2438ea.js" data-stringdex-js="stringdex-a3946164.js" data-settings-js="settings-c38705f0.js" ><script src="../../static.files/storage-e2aeef58.js"></script><script defer src="sidebar-items.js"></script><script defer src="../../static.files/main-a410ff4d.js"></script><noscript><link rel="stylesheet" href="../../static.files/noscript-263c88ec.css"></noscript><link rel="alternate icon" type="image/png" href="../../static.files/favicon-32x32-eab170b8.png"><link rel="icon" type="image/svg+xml" href="../../static.files/favicon-044be391.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]--><rustdoc-topbar><h2><a href="#">try_join_all</a></h2></rustdoc-topbar><nav class="sidebar"><div class="sidebar-crate"><h2><a href="../../futures_util/index.html">futures_<wbr>util</a><span class="version">0.3.32</span></h2></div><div class="sidebar-elems"><section id="rustdoc-toc"><h2 class="location"><a href="#">try_<wbr>join_<wbr>all</a></h2><h3><a href="#">Sections</a></h3><ul class="block top-toc"><li><a href="#see-also" title="See Also">See Also</a></li><li><a href="#examples" title="Examples">Examples</a></li></ul></section><div id="rustdoc-modnav"><h2><a href="index.html">In futures_<wbr>util::<wbr>future</a></h2></div></div></nav><div class="sidebar-resizer" title="Drag to resize sidebar"></div><main><div class="width-limiter"><section id="main-content" class="content"><div class="main-heading"><div class="rustdoc-breadcrumbs"><a href="../index.html">futures_util</a>::<wbr><a href="index.html">future</a></div><h1>Function <span class="fn">try_<wbr>join_<wbr>all</span> <button id="copy-path" title="Copy item path to clipboard">Copy item path</button></h1><rustdoc-toolbar></rustdoc-toolbar><span class="sub-heading"><a class="src" href="../../src/futures_util/future/try_join_all.rs.html#117-149">Source</a> </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.93.1/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.93.1/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.93.1/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 class="doc-anchor" href="#see-also">§</a>See Also</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 class="doc-anchor" href="#examples">§</a>Examples</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.93.1/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.93.1/core/future/future/trait.Future.html#associatedtype.Output\" class=\"associatedtype\">Output</a> = <a class=\"enum\" href=\"https://doc.rust-lang.org/1.93.1/core/result/enum.Result.html\" title=\"enum core::result::Result\">Result</a><<a class=\"struct\" href=\"https://doc.rust-lang.org/1.93.1/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> |