Struct async_executors::iface::JoinHandle

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

A framework agnostic JoinHandle type. Cancels the future on dropping the handle. You can call detach to leave the future running when dropping the handle.

This leverages the performance gains from the native join handles compared to RemoteHandle where possible.

It does wrap futures in Abortable where needed as async-std’s canceling is asynchronous, which we can’t call during drop.

Panics

There is an inconsistency between executors when it comes to a panicking task. Generally we unwind the thread on which the handle is awaited when a task panics, but async-std will also let the executor working thread unwind. No catch_unwind was added to bring async-std in line with the other executors here.

Awaiting the JoinHandle can also panic if you drop the executor before it completes.

Implementations

impl<T> JoinHandle<T>

pub fn tokio(handle: TokioJoinHandle<T>) -> Self

Make a wrapper around tokio::task::JoinHandle.

pub fn async_global(task: AsyncGlobalTask<T>) -> Self

Make a wrapper around [async_global_executor::Task].

pub fn async_std( handle: AsyncStdJoinHandle<Result<T, Aborted>>, a_handle: AbortHandle ) -> Self

Make a wrapper around async_std::task::JoinHandle. The task needs to be wrapped in an abortable so we can cancel it on drop.

pub fn remote_handle(handle: RemoteHandle<T>) -> Self

Make a wrapper around futures_util::future::RemoteHandle.

impl<T> JoinHandle<T>

pub fn detach(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 JoinHandle<T>

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

Formats the value using the given formatter.

impl<T> Drop for JoinHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

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

type Output = T

The type of value produced on completion.

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

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