| <!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="An owned permission to join on a task (await its termination)."><meta name="keywords" content="rust, rustlang, rust-lang, JoinHandle"><title>JoinHandle 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="#">JoinHandle</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.abort">abort</a></li><li><a href="#method.abort_handle">abort_handle</a></li><li><a href="#method.is_finished">is_finished</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-JoinHandle%3CT%3E">Debug</a></li><li><a href="#impl-Drop-for-JoinHandle%3CT%3E">Drop</a></li><li><a href="#impl-Future-for-JoinHandle%3CT%3E">Future</a></li><li><a href="#impl-RefUnwindSafe-for-JoinHandle%3CT%3E">RefUnwindSafe</a></li><li><a href="#impl-Send-for-JoinHandle%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-JoinHandle%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-JoinHandle%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-JoinHandle%3CT%3E">UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-JoinHandle%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-JoinHandle%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-JoinHandle%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-JoinHandle%3CT%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-JoinHandle%3CT%3E">Into<U></a></li><li><a href="#impl-IntoFuture-for-JoinHandle%3CT%3E">IntoFuture</a></li><li><a href="#impl-TryFrom%3CU%3E-for-JoinHandle%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryInto%3CU%3E-for-JoinHandle%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="#">JoinHandle</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/runtime/task/join.rs.html#156-159">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 JoinHandle<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>An owned permission to join on a task (await its termination).</p> |
| <p>This can be thought of as the equivalent of <a href="https://doc.rust-lang.org/nightly/std/thread/struct.JoinHandle.html"><code>std::thread::JoinHandle</code></a> |
| for a Tokio task rather than a thread. Note that the background task |
| associated with this <code>JoinHandle</code> started running immediately when you |
| called spawn, even if you have not yet awaited the <code>JoinHandle</code>.</p> |
| <p>A <code>JoinHandle</code> <em>detaches</em> the associated task when it is dropped, which |
| means that there is no longer any handle to the task, and no way to <code>join</code> |
| on it.</p> |
| <p>This <code>struct</code> is created by the <a href="fn.spawn.html"><code>task::spawn</code></a> and <a href="fn.spawn_blocking.html"><code>task::spawn_blocking</code></a> |
| functions.</p> |
| <h2 id="cancel-safety"><a href="#cancel-safety">Cancel safety</a></h2> |
| <p>The <code>&mut JoinHandle<T></code> type is cancel safe. If it is used as the event |
| in a <code>tokio::select!</code> statement and some other branch completes first, |
| then it is guaranteed that the output of the task is not lost.</p> |
| <p>If a <code>JoinHandle</code> is dropped, then the task continues running in the |
| background and its return value is lost.</p> |
| <h2 id="examples"><a href="#examples">Examples</a></h2> |
| <p>Creation from <a href="fn.spawn.html"><code>task::spawn</code></a>:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task; |
| |
| <span class="kw">let </span>join_handle: task::JoinHandle<<span class="kw">_</span>> = task::spawn(<span class="kw">async </span>{ |
| <span class="comment">// some work here |
| </span>});</code></pre></div> |
| <p>Creation from <a href="fn.spawn_blocking.html"><code>task::spawn_blocking</code></a>:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task; |
| |
| <span class="kw">let </span>join_handle: task::JoinHandle<<span class="kw">_</span>> = task::spawn_blocking(|| { |
| <span class="comment">// some blocking work here |
| </span>});</code></pre></div> |
| <p>The generic parameter <code>T</code> in <code>JoinHandle<T></code> is the return type of the spawned task. |
| If the return value is an i32, the join handle has type <code>JoinHandle<i32></code>:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task; |
| |
| <span class="kw">let </span>join_handle: task::JoinHandle<i32> = task::spawn(<span class="kw">async </span>{ |
| <span class="number">5 </span>+ <span class="number">3 |
| </span>}); |
| </code></pre></div> |
| <p>If the task does not have a return value, the join handle has type <code>JoinHandle<()></code>:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task; |
| |
| <span class="kw">let </span>join_handle: task::JoinHandle<()> = task::spawn(<span class="kw">async </span>{ |
| <span class="macro">println!</span>(<span class="string">"I return nothing."</span>); |
| });</code></pre></div> |
| <p>Note that <code>handle.await</code> doesn’t give you the return type directly. It is wrapped in a |
| <code>Result</code> because panics in the spawned task are caught by Tokio. The <code>?</code> operator has |
| to be double chained to extract the returned value:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task; |
| <span class="kw">use </span>std::io; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="kw">let </span>join_handle: task::JoinHandle<<span class="prelude-ty">Result</span><i32, io::Error>> = tokio::spawn(<span class="kw">async </span>{ |
| <span class="prelude-val">Ok</span>(<span class="number">5 </span>+ <span class="number">3</span>) |
| }); |
| |
| <span class="kw">let </span>result = join_handle.<span class="kw">await</span><span class="question-mark">??</span>; |
| <span class="macro">assert_eq!</span>(result, <span class="number">8</span>); |
| <span class="prelude-val">Ok</span>(()) |
| }</code></pre></div> |
| <p>If the task panics, the error is a <a href="struct.JoinError.html"><code>JoinError</code></a> that contains the panic:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task; |
| <span class="kw">use </span>std::io; |
| <span class="kw">use </span>std::panic; |
| |
| <span class="attribute">#[tokio::main] |
| </span><span class="kw">async fn </span>main() -> io::Result<()> { |
| <span class="kw">let </span>join_handle: task::JoinHandle<<span class="prelude-ty">Result</span><i32, io::Error>> = tokio::spawn(<span class="kw">async </span>{ |
| <span class="macro">panic!</span>(<span class="string">"boom"</span>); |
| }); |
| |
| <span class="kw">let </span>err = join_handle.<span class="kw">await</span>.unwrap_err(); |
| <span class="macro">assert!</span>(err.is_panic()); |
| <span class="prelude-val">Ok</span>(()) |
| } |
| </code></pre></div> |
| <p>Child being detached and outliving its parent:</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::task; |
| <span class="kw">use </span>tokio::time; |
| <span class="kw">use </span>std::time::Duration; |
| |
| <span class="kw">let </span>original_task = task::spawn(<span class="kw">async </span>{ |
| <span class="kw">let </span>_detached_task = task::spawn(<span class="kw">async </span>{ |
| <span class="comment">// Here we sleep to make sure that the first task returns before. |
| </span>time::sleep(Duration::from_millis(<span class="number">10</span>)).<span class="kw">await</span>; |
| <span class="comment">// This will be called, even though the JoinHandle is dropped. |
| </span><span class="macro">println!</span>(<span class="string">"♫ Still alive ♫"</span>); |
| }); |
| }); |
| |
| original_task.<span class="kw">await</span>.expect(<span class="string">"The task being joined has panicked"</span>); |
| <span class="macro">println!</span>(<span class="string">"Original task is joined."</span>); |
| |
| <span class="comment">// We make sure that the new task has time to run, before the main |
| // task returns. |
| |
| </span>time::sleep(Duration::from_millis(<span class="number">1000</span>)).<span class="kw">await</span>;</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-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#168-308">source</a><a href="#impl-JoinHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.abort" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#209-211">source</a><h4 class="code-header">pub fn <a href="#method.abort" class="fnname">abort</a>(&self)</h4></section></summary><div class="docblock"><p>Abort the task associated with the handle.</p> |
| <p>Awaiting a cancelled task might complete as usual if the task was |
| already completed at the time it was cancelled, but most likely it |
| will fail with a <a href="struct.JoinError.html#method.is_cancelled">cancelled</a> <code>JoinError</code>.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::time; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>handles = Vec::new(); |
| |
| handles.push(tokio::spawn(<span class="kw">async </span>{ |
| time::sleep(time::Duration::from_secs(<span class="number">10</span>)).<span class="kw">await</span>; |
| <span class="bool-val">true |
| </span>})); |
| |
| handles.push(tokio::spawn(<span class="kw">async </span>{ |
| time::sleep(time::Duration::from_secs(<span class="number">10</span>)).<span class="kw">await</span>; |
| <span class="bool-val">false |
| </span>})); |
| |
| <span class="kw">for </span>handle <span class="kw">in </span><span class="kw-2">&</span>handles { |
| handle.abort(); |
| } |
| |
| <span class="kw">for </span>handle <span class="kw">in </span>handles { |
| <span class="macro">assert!</span>(handle.<span class="kw">await</span>.unwrap_err().is_cancelled()); |
| }</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.is_finished" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#240-243">source</a><h4 class="code-header">pub fn <a href="#method.is_finished" class="fnname">is_finished</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>Checks if the task associated with this <code>JoinHandle</code> has finished.</p> |
| <p>Please note that this method can return <code>false</code> even if <a href="struct.JoinHandle.html#method.abort"><code>abort</code></a> has been |
| called on the task. This is because the cancellation process may take |
| some time, and this method does not return <code>true</code> until it has |
| completed.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::time; |
| |
| <span class="kw">let </span>handle1 = tokio::spawn(<span class="kw">async </span>{ |
| <span class="comment">// do some stuff here |
| </span>}); |
| <span class="kw">let </span>handle2 = tokio::spawn(<span class="kw">async </span>{ |
| <span class="comment">// do some other stuff here |
| </span>time::sleep(time::Duration::from_secs(<span class="number">10</span>)).<span class="kw">await</span>; |
| }); |
| <span class="comment">// Wait for the task to finish |
| </span>handle2.abort(); |
| time::sleep(time::Duration::from_secs(<span class="number">1</span>)).<span class="kw">await</span>; |
| <span class="macro">assert!</span>(handle1.is_finished()); |
| <span class="macro">assert!</span>(handle2.is_finished());</code></pre></div> |
| </div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.abort_handle" class="method has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#288-291">source</a><h4 class="code-header">pub fn <a href="#method.abort_handle" class="fnname">abort_handle</a>(&self) -> <a class="struct" href="struct.AbortHandle.html" title="struct tokio::task::AbortHandle">AbortHandle</a></h4></section></summary><div class="docblock"><p>Returns a new <code>AbortHandle</code> that can be used to remotely abort this task.</p> |
| <p>Awaiting a task cancelled by the <code>AbortHandle</code> might complete as usual if the task was |
| already completed at the time it was cancelled, but most likely it |
| will fail with a <a href="struct.JoinError.html#method.is_cancelled">cancelled</a> <code>JoinError</code>.</p> |
| |
| <div class="example-wrap"><pre class="rust rust-example-rendered"><code><span class="kw">use </span>tokio::{time, task}; |
| |
| <span class="kw">let </span><span class="kw-2">mut </span>handles = Vec::new(); |
| |
| handles.push(tokio::spawn(<span class="kw">async </span>{ |
| time::sleep(time::Duration::from_secs(<span class="number">10</span>)).<span class="kw">await</span>; |
| <span class="bool-val">true |
| </span>})); |
| |
| handles.push(tokio::spawn(<span class="kw">async </span>{ |
| time::sleep(time::Duration::from_secs(<span class="number">10</span>)).<span class="kw">await</span>; |
| <span class="bool-val">false |
| </span>})); |
| |
| <span class="kw">let </span>abort_handles: Vec<task::AbortHandle> = handles.iter().map(|h| h.abort_handle()).collect(); |
| |
| <span class="kw">for </span>handle <span class="kw">in </span>abort_handles { |
| handle.abort(); |
| } |
| |
| <span class="kw">for </span>handle <span class="kw">in </span>handles { |
| <span class="macro">assert!</span>(handle.<span class="kw">await</span>.unwrap_err().is_cancelled()); |
| }</code></pre></div> |
| </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-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#355-365">source</a><a href="#impl-Debug-for-JoinHandle%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.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><T><span class="where fmt-newline">where<br> T: <a class="trait" href="https://doc.rust-lang.org/nightly/core/fmt/trait.Debug.html" title="trait core::fmt::Debug">Debug</a>,</span></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/runtime/task/join.rs.html#359-364">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, fmt: &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-Drop-for-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#345-353">source</a><a href="#impl-Drop-for-JoinHandle%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.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</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/runtime/task/join.rs.html#346-352">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><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Future-for-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#312-343">source</a><a href="#impl-Future-for-JoinHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a> for <a class="struct" href="struct.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" class="associatedtype">Output</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'>The type of value produced on completion.</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.poll" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#315-342">source</a><a href="#method.poll" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#tymethod.poll" class="fnname">poll</a>(self: <a class="struct" href="https://doc.rust-lang.org/nightly/core/pin/struct.Pin.html" title="struct core::pin::Pin">Pin</a><<a class="primitive" href="https://doc.rust-lang.org/nightly/std/primitive.reference.html">&mut </a>Self>, cx: &mut <a class="struct" href="https://doc.rust-lang.org/nightly/core/task/wake/struct.Context.html" title="struct core::task::wake::Context">Context</a><'_>) -> <a class="enum" href="https://doc.rust-lang.org/nightly/core/task/poll/enum.Poll.html" title="enum core::task::poll::Poll">Poll</a><Self::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a>></h4></section></summary><div class='docblock'>Attempt to resolve the future to a final value, registering |
| the current task for wakeup if the value is not yet available. <a href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#tymethod.poll">Read more</a></div></details></div></details><section id="impl-RefUnwindSafe-for-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#166">source</a><a href="#impl-RefUnwindSafe-for-JoinHandle%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.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><T></h3></section><section id="impl-Send-for-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#162">source</a><a href="#impl-Send-for-JoinHandle%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>> <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.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><T></h3></section><section id="impl-Sync-for-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#163">source</a><a href="#impl-Sync-for-JoinHandle%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>> <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.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><T></h3></section><section id="impl-Unpin-for-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#310">source</a><a href="#impl-Unpin-for-JoinHandle%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.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</a><T></h3></section><section id="impl-UnwindSafe-for-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/tokio/runtime/task/join.rs.html#165">source</a><a href="#impl-UnwindSafe-for-JoinHandle%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.JoinHandle.html" title="struct tokio::task::JoinHandle">JoinHandle</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-JoinHandle%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-JoinHandle%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-JoinHandle%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-JoinHandle%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-JoinHandle%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-JoinHandle%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-JoinHandle%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-JoinHandle%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-JoinHandle%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-JoinHandle%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-IntoFuture-for-JoinHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/future/into_future.rs.html#132">source</a><a href="#impl-IntoFuture-for-JoinHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<F> <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a> for F<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>,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Output-1" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Output-1" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.Output" class="associatedtype">Output</a> = <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html" title="trait core::future::future::Future">Future</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/future/future/trait.Future.html#associatedtype.Output" title="type core::future::future::Future::Output">Output</a></h4></section></summary><div class='docblock'>The output that the future will produce on completion.</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.IntoFuture" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.IntoFuture" class="anchor"></a><h4 class="code-header">type <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.IntoFuture" class="associatedtype">IntoFuture</a> = F</h4></section></summary><div class='docblock'>Which kind of future are we turning this into?</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.into_future" class="method trait-impl has-srclink"><a class="srclink rightside" href="https://doc.rust-lang.org/nightly/src/core/future/into_future.rs.html#136">source</a><a href="#method.into_future" class="anchor"></a><h4 class="code-header">fn <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#tymethod.into_future" class="fnname">into_future</a>(self) -> <F as <a class="trait" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html" title="trait core::future::into_future::IntoFuture">IntoFuture</a>>::<a class="associatedtype" href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#associatedtype.IntoFuture" title="type core::future::into_future::IntoFuture::IntoFuture">IntoFuture</a></h4></section></summary><div class='docblock'>Creates a future from a value. <a href="https://doc.rust-lang.org/nightly/core/future/into_future/trait.IntoFuture.html#tymethod.into_future">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-JoinHandle%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-JoinHandle%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-JoinHandle%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-JoinHandle%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> |
