| <!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="The handle to a remote future returned by `remote_handle`. When you drop this, the remote future will be woken up to be dropped by the executor."><meta name="keywords" content="rust, rustlang, rust-lang, RemoteHandle"><title>RemoteHandle in futures_util::future - 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="../../futures_util/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="../../futures_util/index.html"><div class="logo-container"><img class="rust-logo" src="../../rust-logo.svg" alt="logo"></div></a><h2 class="location"><a href="#">RemoteHandle</a></h2><div class="sidebar-elems"><section><h3><a href="#implementations">Methods</a></h3><ul class="block"><li><a href="#method.forget">forget</a></li></ul><h3><a href="#trait-implementations">Trait Implementations</a></h3><ul class="block"><li><a href="#impl-Debug-for-RemoteHandle%3CT%3E">Debug</a></li><li><a href="#impl-Future-for-RemoteHandle%3CT%3E">Future</a></li></ul><h3><a href="#synthetic-implementations">Auto Trait Implementations</a></h3><ul class="block"><li><a href="#impl-RefUnwindSafe-for-RemoteHandle%3CT%3E">!RefUnwindSafe</a></li><li><a href="#impl-Send-for-RemoteHandle%3CT%3E">Send</a></li><li><a href="#impl-Sync-for-RemoteHandle%3CT%3E">Sync</a></li><li><a href="#impl-Unpin-for-RemoteHandle%3CT%3E">Unpin</a></li><li><a href="#impl-UnwindSafe-for-RemoteHandle%3CT%3E">!UnwindSafe</a></li></ul><h3><a href="#blanket-implementations">Blanket Implementations</a></h3><ul class="block"><li><a href="#impl-Any-for-RemoteHandle%3CT%3E">Any</a></li><li><a href="#impl-Borrow%3CT%3E-for-RemoteHandle%3CT%3E">Borrow<T></a></li><li><a href="#impl-BorrowMut%3CT%3E-for-RemoteHandle%3CT%3E">BorrowMut<T></a></li><li><a href="#impl-From%3CT%3E-for-RemoteHandle%3CT%3E">From<T></a></li><li><a href="#impl-Into%3CU%3E-for-RemoteHandle%3CT%3E">Into<U></a></li><li><a href="#impl-IntoFuture-for-RemoteHandle%3CT%3E">IntoFuture</a></li><li><a href="#impl-TryFrom%3CU%3E-for-RemoteHandle%3CT%3E">TryFrom<U></a></li><li><a href="#impl-TryFuture-for-RemoteHandle%3CT%3E">TryFuture</a></li><li><a href="#impl-TryInto%3CU%3E-for-RemoteHandle%3CT%3E">TryInto<U></a></li></ul></section><h2><a href="index.html">In futures_util::future</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">futures_util</a>::<wbr><a href="index.html">future</a>::<wbr><a class="struct" href="#">RemoteHandle</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/futures_util/future/future/remote_handle.rs.html#42-45">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 RemoteHandle<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>The handle to a remote future returned by |
| <a href="trait.FutureExt.html#method.remote_handle"><code>remote_handle</code></a>. When you drop this, |
| the remote future will be woken up to be dropped by the executor.</p> |
| <h3 id="unwind-safety"><a href="#unwind-safety">Unwind safety</a></h3> |
| <p>When the remote future panics, <a href="struct.Remote.html" title="Remote">Remote</a> will catch the unwind and transfer it to |
| the thread where <code>RemoteHandle</code> is being awaited. This is good for the common |
| case where <a href="struct.Remote.html" title="Remote">Remote</a> is spawned on a threadpool. It is unlikely that other code |
| in the executor working thread shares mutable data with the spawned future and we |
| preserve the executor from losing its working threads.</p> |
| <p>If you run the future locally and send the handle of to be awaited elsewhere, you |
| must be careful with regard to unwind safety because the thread in which the future |
| is polled will keep running after the panic and the thread running the <a href="struct.RemoteHandle.html" title="RemoteHandle">RemoteHandle</a> |
| will unwind.</p> |
| </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-RemoteHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/future/remote_handle.rs.html#47-55">source</a><a href="#impl-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> <a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</a><T></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle method-toggle" open><summary><section id="method.forget" class="method has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/future/remote_handle.rs.html#52-54">source</a><h4 class="code-header">pub fn <a href="#method.forget" class="fnname">forget</a>(self)</h4></section></summary><div class="docblock"><p>Drops this handle <em>without</em> canceling the underlying future.</p> |
| <p>This method can be used if you want to drop the handle, but let the |
| execution continue.</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-RemoteHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/future/remote_handle.rs.html#40">source</a><a href="#impl-Debug-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: Debug> Debug for <a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</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/futures_util/future/future/remote_handle.rs.html#40">source</a><a href="#method.fmt" class="anchor"></a><h4 class="code-header">fn <a class="fnname">fmt</a>(&self, f: &mut Formatter<'_>) -> Result</h4></section></summary><div class='docblock'>Formats the value using the given formatter. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle" open><summary><section id="impl-Future-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_util/future/future/remote_handle.rs.html#57-69">source</a><a href="#impl-Future-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T: 'static> Future for <a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</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 class="associatedtype">Output</a> = T</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/futures_util/future/future/remote_handle.rs.html#60-68">source</a><a href="#method.poll" class="anchor"></a><h4 class="code-header">fn <a class="fnname">poll</a>(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<T></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>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-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-RefUnwindSafe-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !RefUnwindSafe for <a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</a><T></h3></section><section id="impl-Send-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-Send-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Send for <a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</a><T><span class="where fmt-newline">where<br> T: Send,</span></h3></section><section id="impl-Sync-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-Sync-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Sync for <a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</a><T><span class="where fmt-newline">where<br> T: Send,</span></h3></section><section id="impl-Unpin-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-Unpin-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Unpin for <a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</a><T></h3></section><section id="impl-UnwindSafe-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-UnwindSafe-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> !UnwindSafe for <a class="struct" href="struct.RemoteHandle.html" title="struct futures_util::future::RemoteHandle">RemoteHandle</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-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-Any-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Any for T<span class="where fmt-newline">where<br> T: 'static + ?Sized,</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 href="#method.type_id" class="anchor"></a><h4 class="code-header">fn <a class="fnname">type_id</a>(&self) -> TypeId</h4></section></summary><div class='docblock'>Gets the <code>TypeId</code> of <code>self</code>. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-Borrow%3CT%3E-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-Borrow%3CT%3E-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> Borrow<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow</a>(&self) -> &T</h4></section></summary><div class='docblock'>Immutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-BorrowMut%3CT%3E-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-BorrowMut%3CT%3E-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> BorrowMut<T> for T<span class="where fmt-newline">where<br> T: ?Sized,</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/91522" title="Tracking issue for const_borrow">unstable</a></span><a href="#method.borrow_mut" class="anchor"></a><h4 class="code-header">fn <a class="fnname">borrow_mut</a>(&mut self) -> &mut T</h4></section></summary><div class='docblock'>Mutably borrows from an owned value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-From%3CT%3E-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-From%3CT%3E-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T> From<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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.from" class="anchor"></a><h4 class="code-header">fn <a 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-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-Into%3CU%3E-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> Into<U> for T<span class="where fmt-newline">where<br> U: From<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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.into" class="anchor"></a><h4 class="code-header">fn <a 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>[From]<T> for U</code> chooses to do.</p> |
| </div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-IntoFuture-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-IntoFuture-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<F> IntoFuture for F<span class="where fmt-newline">where<br> F: Future,</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 class="associatedtype">Output</a> = <F as Future>::Output</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 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 href="#method.into_future" class="anchor"></a><h4 class="code-header">fn <a class="fnname">into_future</a>(self) -> <F as IntoFuture>::IntoFuture</h4></section></summary><div class='docblock'>Creates a future from a value. <a>Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFrom%3CU%3E-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-TryFrom%3CU%3E-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryFrom<U> for T<span class="where fmt-newline">where<br> U: Into<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 class="associatedtype">Error</a> = Infallible</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_from" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_from</a>(value: U) -> Result<T, <T as TryFrom<U>>::Error></h4></section></summary><div class='docblock'>Performs the conversion.</div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryFuture-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#73">source</a><a href="#impl-TryFuture-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<F, T, E> <a class="trait" href="trait.TryFuture.html" title="trait futures_util::future::TryFuture">TryFuture</a> for F<span class="where fmt-newline">where<br> F: Future<Output = Result<T, E>> + ?Sized,</span></h3></section></summary><div class="impl-items"><details class="rustdoc-toggle" open><summary><section id="associatedtype.Ok" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Ok" class="anchor"></a><h4 class="code-header">type <a href="trait.TryFuture.html#associatedtype.Ok" class="associatedtype">Ok</a> = T</h4></section></summary><div class='docblock'>The type of successful values yielded by this future</div></details><details class="rustdoc-toggle" open><summary><section id="associatedtype.Error-2" class="associatedtype trait-impl has-srclink"><a href="#associatedtype.Error-2" class="anchor"></a><h4 class="code-header">type <a href="trait.TryFuture.html#associatedtype.Error" class="associatedtype">Error</a> = E</h4></section></summary><div class='docblock'>The type of failures yielded by this future</div></details><details class="rustdoc-toggle method-toggle" open><summary><section id="method.try_poll" class="method trait-impl has-srclink"><a class="srclink rightside" href="../../src/futures_core/future.rs.html#81">source</a><a href="#method.try_poll" class="anchor"></a><h4 class="code-header">fn <a href="trait.TryFuture.html#tymethod.try_poll" class="fnname">try_poll</a>(<br> self: Pin<&mut F>,<br> cx: &mut Context<'_><br>) -> Poll<<F as Future>::Output></h4></section></summary><div class='docblock'>Poll this <code>TryFuture</code> as if it were a <code>Future</code>. <a href="trait.TryFuture.html#tymethod.try_poll">Read more</a></div></details></div></details><details class="rustdoc-toggle implementors-toggle"><summary><section id="impl-TryInto%3CU%3E-for-RemoteHandle%3CT%3E" class="impl has-srclink"><a href="#impl-TryInto%3CU%3E-for-RemoteHandle%3CT%3E" class="anchor"></a><h3 class="code-header">impl<T, U> TryInto<U> for T<span class="where fmt-newline">where<br> U: TryFrom<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 class="associatedtype">Error</a> = <U as TryFrom<T>>::Error</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="since rightside" title="const unstable">const: <a href="https://github.com/rust-lang/rust/issues/88674" title="Tracking issue for const_convert">unstable</a></span><a href="#method.try_into" class="anchor"></a><h4 class="code-header">fn <a class="fnname">try_into</a>(self) -> Result<U, <U as TryFrom<T>>::Error></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="futures_util" data-themes="ayu,dark,light" data-resource-suffix="" data-rustdoc-version="1.66.0-nightly (5c8bff74b 2022-10-21)" ></div></body></html> |
