Struct futures_util::future::RemoteHandle

pub struct RemoteHandle<T> { /* private fields */ }

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.

Unwind safety

When the remote future panics, Remote will catch the unwind and transfer it to the thread where RemoteHandle is being awaited. This is good for the common case where Remote 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.

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 RemoteHandle will unwind.

Implementations

impl<T> RemoteHandle<T>

pub fn forget(self)

Drops this handle without canceling the underlying future.

This method can be used if you want to drop the handle, but let the execution continue.

Trait Implementations

impl<T: Debug> Debug for RemoteHandle<T>

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<T: 'static> Future for RemoteHandle<T>

type Output = T

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<T>

Attempt to resolve the future to a final value, registering the current task for wakeup if the value is not yet available.