| <!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="A collection of tasks spawned on a Tokio runtime."><meta name="keywords" content="rust, rustlang, rust-lang, JoinSet"><title>JoinSet in tokio::task - Rust</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="sidebar-items.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 struct"><!--[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><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2></h2></nav><nav class="sidebar"><a class="sidebar-logo" href="../../tokio/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">JoinSet</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.abort_all">abort_all</a></li><li><a href="#method.detach_all">detach_all</a></li><li><a href="#method.is_empty">is_empty</a></li><li><a href="#method.join_next">join_next</a></li><li><a href="#method.len">len</a></li><li><a href="#method.new">new</a></li><li><a href="#method.shutdown">shutdown</a></li><li><a href="#method.spawn">spawn</a></li><li><a href="#method.spawn_blocking">spawn_blocking</a></li><li><a href="#method.spawn_blocking_on">spawn_blocking_on</a></li><li><a href="#method.spawn_local">spawn_local</a></li><li><a href="#method.spawn_local_on">spawn_local_on</a></li><li><a href="#method.spawn_on">spawn_on</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-JoinSet%3CT%3E">Debug</a></li><li><a href="#impl-Default-for-JoinSet%3CT%3E">Default</a></li><li><a href="#impl-Drop-for-JoinSet%3CT%3E">Drop</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-JoinSet%3CT%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-JoinSet%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-JoinSet%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-JoinSet%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-JoinSet%3CT%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-JoinSet%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-JoinSet%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-JoinSet%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-JoinSet%3CT%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-JoinSet%3CT%3E">Into<U></a></li><li><a href="#impl-TryFrom%3CU%3E-for-JoinSet%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-JoinSet%3CT%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In tokio::task</a></h2></div></nav><main><div class="width-limiter"><nav class="sub"><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="main-heading"><h1 class="fqn">Struct <a href="../index.html">tokio</a>::<wbr><a href="index.html">task</a>::<wbr><a class="struct" href="#">JoinSet</a><button id="copy-path" onclick="copy_path(this)" title="Copy item path to clipboard"><img src="../../clipboard.svg" width="19" height="18" alt="Copy item path"></button></h1><span class="out-of-band"><a class="srclink" href="../../src/tokio/task/join_set.rs.html#55-57">source</a> · <a id="toggle-all-docs" href="javascript:void(0)" title="collapse all docs">[<span class="inner">−</span>]</a></span></div><div class="item-decl"><pre class="rust struct"><code>pub struct JoinSet<T> { /* private fields */ }</code></pre></div><details class="rustdoc-toggle top-doc" open><summary class="hideme"><span>Expand description</span></summary><div class="docblock"><p>A collection of tasks spawned on a Tokio runtime.</p> |
| <p>A <code>JoinSet</code> can be used to await the completion of some or all of the tasks |
| in the set. The set is not ordered, and the tasks will be returned in the |
| order they complete.</p> |
| <p>All of the tasks must have the same return type <code>T</code>.</p> |
| <p>When the <code>JoinSet</code> is dropped, all tasks in the <code>JoinSet</code> are immediately aborted.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <p>Spawn multiple tasks and wait for them.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task::JoinSet; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span><span class="kw-2">mut </span>set = JoinSet::new(); |
| |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{ |
| set.spawn(<span class="kw">async move </span>{ i }); |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>seen = [<span class="bool-val">false</span>; <span class="number">10</span>]; |
| <span class="kw">while let </span><span class="prelude-val">Some</span>(res) = set.join_next().<span class="kw">await </span>{ |
| <span class="kw">let </span>idx = res.unwrap(); |
| seen[idx] = <span class="bool-val">true</span>; |
| } |
| |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{ |
| <span class="macro">assert!</span>(seen[i]); |
| } |
| }</code></pre></div> |
| </div></details><h2 id="implementations" class="small-section-header">Implementations<a href="#implementations" class="anchor"></a></h2><div id="implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#71-88">source</a><a href="#impl-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.new" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#73-77">source</a><h4 class="code-header">pub fn <a href="#method.new" class="fnname">new</a>() -> Self</h4></section></summary><div class="docblock"><p>Create a new <code>JoinSet</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.len" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#80-82">source</a><h4 class="code-header">pub fn <a href="#method.len" class="fnname">len</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.usize.html">usize</a></h4></section></summary><div class="docblock"><p>Returns the number of tasks currently in the <code>JoinSet</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_empty" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#85-87">source</a><h4 class="code-header">pub fn <a href="#method.is_empty" class="fnname">is_empty</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.bool.html">bool</a></h4></section></summary><div class="docblock"><p>Returns whether the <code>JoinSet</code> is empty.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-JoinSet%3CT%3E-1" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#90-455">source</a><a href="#impl-JoinSet%3CT%3E-1" class="anchor"></a><h3 class="code-header">impl<T: 'static> <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.spawn" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#133-140">source</a><h4 class="code-header">pub fn <a href="#method.spawn" class="fnname">spawn</a><F>(&mut self, task: F) -> <a class="struct" href="struct.AbortHandle.html" title="struct tokio::task::AbortHandle">AbortHandle</a><span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h4></section></summary><div class="docblock"><p>Spawn the provided task on the <code>JoinSet</code>, returning an <a href="struct.AbortHandle.html"><code>AbortHandle</code></a> |
| that can be used to remotely cancel the task.</p> |
| <p>The provided future will start running in the background immediately |
| when this method is called, even if you don’t await anything on this |
| <code>JoinSet</code>.</p> |
| <h5 id="panics"><a href="#panics">Panics</a></h5> |
| <p>This method panics if called outside of a Tokio runtime.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.spawn_on" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#152-159">source</a><h4 class="code-header">pub fn <a href="#method.spawn_on" class="fnname">spawn_on</a><F>(&mut self, task: F, handle: &<a class="struct" href="../runtime/struct.Handle.html" title="struct tokio::runtime::Handle">Handle</a>) -> <a class="struct" href="struct.AbortHandle.html" title="struct tokio::task::AbortHandle">AbortHandle</a><span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T>,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h4></section></summary><div class="docblock"><p>Spawn the provided task on the provided runtime and store it in this |
| <code>JoinSet</code> returning an <a href="struct.AbortHandle.html"><code>AbortHandle</code></a> that can be used to remotely |
| cancel the task.</p> |
| <p>The provided future will start running in the background immediately |
| when this method is called, even if you don’t await anything on this |
| <code>JoinSet</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.spawn_local" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#176-182">source</a><h4 class="code-header">pub fn <a href="#method.spawn_local" class="fnname">spawn_local</a><F>(&mut self, task: F) -> <a class="struct" href="struct.AbortHandle.html" title="struct tokio::task::AbortHandle">AbortHandle</a><span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T>,<br> F: 'static,</span></h4></section></summary><div class="docblock"><p>Spawn the provided task on the current <a href="struct.LocalSet.html"><code>LocalSet</code></a> and store it in this |
| <code>JoinSet</code>, returning an <a href="struct.AbortHandle.html"><code>AbortHandle</code></a> that can be used to remotely |
| cancel the task.</p> |
| <p>The provided future will start running in the background immediately |
| when this method is called, even if you don’t await anything on this |
| <code>JoinSet</code>.</p> |
| <h5 id="panics-1"><a href="#panics-1">Panics</a></h5> |
| <p>This method panics if it is called outside of a <code>LocalSet</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.spawn_local_on" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#196-202">source</a><h4 class="code-header">pub fn <a href="#method.spawn_local_on" class="fnname">spawn_local_on</a><F>(&mut self, task: F, local_set: &<a class="struct" href="struct.LocalSet.html" title="struct tokio::task::LocalSet">LocalSet</a>) -> <a class="struct" href="struct.AbortHandle.html" title="struct tokio::task::AbortHandle">AbortHandle</a><span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a><Output = T>,<br> F: 'static,</span></h4></section></summary><div class="docblock"><p>Spawn the provided task on the provided <a href="struct.LocalSet.html"><code>LocalSet</code></a> and store it in |
| this <code>JoinSet</code>, returning an <a href="struct.AbortHandle.html"><code>AbortHandle</code></a> that can be used to |
| remotely cancel the task.</p> |
| <p>Unlike the <a href="struct.JoinSet.html#method.spawn_local"><code>spawn_local</code></a> method, this method may be used to spawn local |
| tasks on a <code>LocalSet</code> that is <em>not</em> currently running. The provided |
| future will start running whenever the <code>LocalSet</code> is next started.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.spawn_blocking" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#241-248">source</a><h4 class="code-header">pub fn <a href="#method.spawn_blocking" class="fnname">spawn_blocking</a><F>(&mut self, f: F) -> <a class="struct" href="struct.AbortHandle.html" title="struct tokio::task::AbortHandle">AbortHandle</a><span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> T,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h4></section></summary><div class="docblock"><p>Spawn the blocking code on the blocking threadpool and store |
| it in this <code>JoinSet</code>, returning an <a href="struct.AbortHandle.html"><code>AbortHandle</code></a> that can be |
| used to remotely cancel the task.</p> |
| <h5 id="examples-1"><a href="#examples-1">Examples</a></h5> |
| <p>Spawn multiple blocking tasks and wait for them.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task::JoinSet; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() { |
| <span class="kw">let </span><span class="kw-2">mut </span>set = JoinSet::new(); |
| |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{ |
| set.spawn_blocking(<span class="kw">move </span>|| { i }); |
| } |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>seen = [<span class="bool-val">false</span>; <span class="number">10</span>]; |
| <span class="kw">while let </span><span class="prelude-val">Some</span>(res) = set.join_next().<span class="kw">await </span>{ |
| <span class="kw">let </span>idx = res.unwrap(); |
| seen[idx] = <span class="bool-val">true</span>; |
| } |
| |
| <span class="kw">for </span>i <span class="kw">in </span><span class="number">0</span>..<span class="number">10 </span>{ |
| <span class="macro">assert!</span>(seen[i]); |
| } |
| }</code></pre></div> |
| <h5 id="panics-2"><a href="#panics-2">Panics</a></h5> |
| <p>This method panics if called outside of a Tokio runtime.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.spawn_blocking_on" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#256-263">source</a><h4 class="code-header">pub fn <a href="#method.spawn_blocking_on" class="fnname">spawn_blocking_on</a><F>(&mut self, f: F, handle: &<a class="struct" href="../runtime/struct.Handle.html" title="struct tokio::runtime::Handle">Handle</a>) -> <a class="struct" href="struct.AbortHandle.html" title="struct tokio::task::AbortHandle">AbortHandle</a><span class="where fmt-newline">where<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/function/trait.FnOnce.html" title="trait core::ops::function::FnOnce">FnOnce</a>() -> T,<br> F: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> + 'static,<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h4></section></summary><div class="docblock"><p>Spawn the blocking code on the blocking threadpool of the |
| provided runtime and store it in this <code>JoinSet</code>, returning an |
| <a href="struct.AbortHandle.html"><code>AbortHandle</code></a> that can be used to remotely cancel the task.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.join_next" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#283-285">source</a><h4 class="code-header">pub async fn <a href="#method.join_next" class="fnname">join_next</a>(&mut self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/option/enum.Option.html" title="enum core::option::Option">Option</a><<a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <a class="struct" href="struct.JoinError.html" title="struct tokio::task::JoinError">JoinError</a>>></h4></section></summary><div class="docblock"><p>Waits until one of the tasks in the set completes and returns its output.</p> |
| <p>Returns <code>None</code> if the set is empty.</p> |
| <h5 id="cancel-safety"><a href="#cancel-safety">Cancel Safety</a></h5> |
| <p>This method is cancel safe. If <code>join_next</code> is used as the event in a <code>tokio::select!</code> |
| statement and some other branch completes first, it is guaranteed that no tasks were |
| removed from this <code>JoinSet</code>.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.shutdown" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#319-322">source</a><h4 class="code-header">pub async fn <a href="#method.shutdown" class="fnname">shutdown</a>(&mut self)</h4></section></summary><div class="docblock"><p>Aborts all tasks and waits for them to finish shutting down.</p> |
| <p>Calling this method is equivalent to calling <a href="struct.JoinSet.html#method.abort_all"><code>abort_all</code></a> and then calling <a href="struct.JoinSet.html#method.join_next"><code>join_next</code></a> in |
| a loop until it returns <code>None</code>.</p> |
| <p>This method ignores any panics in the tasks shutting down. When this call returns, the |
| <code>JoinSet</code> will be empty.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.abort_all" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#328-330">source</a><h4 class="code-header">pub fn <a href="#method.abort_all" class="fnname">abort_all</a>(&mut self)</h4></section></summary><div class="docblock"><p>Aborts all tasks on this <code>JoinSet</code>.</p> |
| <p>This does not remove the tasks from the <code>JoinSet</code>. To wait for the tasks to complete |
| cancellation, you should call <code>join_next</code> in a loop until the <code>JoinSet</code> is empty.</p> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.detach_all" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#336-338">source</a><h4 class="code-header">pub fn <a href="#method.detach_all" class="fnname">detach_all</a>(&mut self)</h4></section></summary><div class="docblock"><p>Removes all tasks from this <code>JoinSet</code> without aborting them.</p> |
| <p>The tasks removed by this call will continue to run in the background even if the <code>JoinSet</code> |
| is dropped.</p> |
| </div></details></div></details></div><h2 id="trait-implementations" class="small-section-header">Trait Implementations<a href="#trait-implementations" class="anchor"></a></h2><div id="trait-implementations-list"><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Debug-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#463-467">source</a><a href="#impl-Debug-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a> for <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.fmt" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#464-466">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt" class="fnname">fmt</a>(&self, f: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/fmt/struct.Formatter.html" title="struct core::fmt::Formatter">Formatter</a><'_>) -> <a class="type" href="https://doc.rust-lang.org/nightly/core/fmt/type.Result.html" title="type core::fmt::Result">Result</a></h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html#tymethod.fmt">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Default-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#469-473">source</a><a href="#impl-Default-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html" title="trait core::default::Default">Default</a> for <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.default" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#470-472">source</a><a href="#method.default" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default" class="fnname">default</a>() -> Self</h4></section></summary><div class='docblock'>Returns the “default value” for a type. <a href="https://doc.rust-lang.org/nightly/core/default/trait.Default.html#tymethod.default">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Drop-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#457-461">source</a><a href="#impl-Drop-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html" title="trait core::ops::drop::Drop">Drop</a> for <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.drop" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/task/join_set.rs.html#458-460">source</a><a href="#method.drop" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop" class="fnname">drop</a>(&mut self)</h4></section></summary><div class='docblock'>Executes the destructor for this type. <a href="https://doc.rust-lang.org/nightly/core/ops/drop/trait.Drop.html#tymethod.drop">Read more</a></div></details></div></details></div><h2 id="synthetic-implementations" class="small-section-header">Auto Trait Implementations<a href="#synthetic-implementations" class="anchor"></a></h2><div id="synthetic-implementations-list"><section id="impl-RefUnwindSafe-for-JoinSet%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.RefUnwindSafe.html" title="trait core::panic::unwind_safe::RefUnwindSafe">RefUnwindSafe</a> for <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T></h3></section><section id="impl-Send-for-JoinSet%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a> for <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h3></section><section id="impl-Sync-for-JoinSet%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sync.html" title="trait core::marker::Sync">Sync</a> for <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Send.html" title="trait core::marker::Send">Send</a>,</span></h3></section><section id="impl-Unpin-for-JoinSet%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Unpin.html" title="trait core::marker::Unpin">Unpin</a> for <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T></h3></section><section id="impl-UnwindSafe-for-JoinSet%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/panic/unwind_safe/trait.UnwindSafe.html" title="trait core::panic::unwind_safe::UnwindSafe">UnwindSafe</a> for <a class="struct" href="struct.JoinSet.html" title="struct tokio::task::JoinSet">JoinSet</a><T></h3></section></div><h2 id="blanket-implementations" class="small-section-header">Blanket Implementations<a href="#blanket-implementations" class="anchor"></a></h2><div id="blanket-implementations-list"><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Any-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#200">source</a><a href="#impl-Any-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html" title="trait core::any::Any">Any</a> for T<span class="where fmt-newline">where<br> T: 'static + ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.type_id" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/any.rs.html#201">source</a><a href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id" class="fnname">type_id</a>(&self) -> <a class="struct" href="https://doc.rust-lang.org/nightly/core/any/struct.TypeId.html" title="struct core::any::TypeId">TypeId</a></h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a href="https://doc.rust-lang.org/nightly/core/any/trait.Any.html#tymethod.type_id">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#211">source</a><a href="#impl-Borrow%3CT%3E-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html" title="trait core::borrow::Borrow">Borrow</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#213">source</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow" class="fnname">borrow</a>(&self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&</a>T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.Borrow.html#tymethod.borrow">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#220">source</a><a href="#impl-BorrowMut%3CT%3E-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html" title="trait core::borrow::BorrowMut">BorrowMut</a><T> for T<span class="where fmt-newline">where<br> T: ?<a class="trait" href="https://doc.rust-lang.org/nightly/core/marker/trait.Sized.html" title="trait core::marker::Sized">Sized</a>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.borrow_mut" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/borrow.rs.html#221">source</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut" class="fnname">borrow_mut</a>(&mut self) -> <a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a href="https://doc.rust-lang.org/nightly/core/borrow/trait.BorrowMut.html#tymethod.borrow_mut">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#733">source</a><a href="#impl-From%3CT%3E-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T> for T</h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#736">source</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html#tymethod.from" class="fnname">from</a>(t: T) -> T</h4></section></summary><div class="docblock"><p>Returns the argument unchanged.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Into%3CU%3E-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#717">source</a><a href="#impl-Into%3CU%3E-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="trait core::convert::From">From</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#725">source</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html#tymethod.into" class="fnname">into</a>(self) -> U</h4></section></summary><div class="docblock"><p>Calls <code>U::from(self)</code>.</p> |
| <p>That is, this conversion is whatever the implementation of |
| <code><a href="https://doc.rust-lang.org/nightly/core/convert/trait.From.html" title="From">From</a><T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#775">source</a><a href="#impl-TryFrom%3CU%3E-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.Into.html" title="trait core::convert::Into">Into</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" class="associatedtype">Error</a> = <a class="enum" href="https://doc.rust-lang.org/nightly/core/convert/enum.Infallible.html" title="enum core::convert::Infallible">Infallible</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_from" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#781">source</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#tymethod.try_from" class="fnname">try_from</a>(value: U) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><T, <T as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><U>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-JoinSet%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#760">source</a><a href="#impl-TryInto%3CU%3E-for-JoinSet%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html" title="trait core::convert::TryInto">TryInto</a><U> for T<span class="where fmt-newline">where<br> U: <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#associatedtype.Error" class="associatedtype">Error</a> = <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a></h4></section></summary><div class='docblock'>The type returned in the event of a conversion error.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_into" class="method trait-impl has-srclink"><span class="rightside"><span class="since" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span> · <a class="srclink" href="https://doc.rust-lang.org/nightly/src/core/convert/mod.rs.html#766">source</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/convert/trait.TryInto.html#tymethod.try_into" class="fnname">try_into</a>(self) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/result/enum.Result.html" title="enum core::result::Result">Result</a><U, <U as <a class="trait" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html" title="trait core::convert::TryFrom">TryFrom</a><T>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/convert/trait.TryFrom.html#associatedtype.Error" title="type core::convert::TryFrom::Error">Error</a>></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details></div></section></div></main><div id="rustdoc-vars" data-root-path="../../" data-current-crate="tokio" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
