Struct async_task::JoinHandle

pub struct JoinHandle<R, T> { /* fields omitted */ }

A handle that awaits the result of a task.

This type is a future that resolves to an Option<R> where:

• None indicates the task has panicked or was cancelled.
• Some(result) indicates the task has completed with result of type R.

Methods

impl<R, T> JoinHandle<R, T>

pub fn cancel(&self)

Cancels the task.

If the task has already completed, calling this method will have no effect.

When a task is cancelled, its future will not be polled again.

pub fn tag(&self) -> &T

Returns a reference to the tag stored inside the task.

pub fn waker(&self) -> Waker

Returns a waker associated with the task.

Trait Implementations

impl<R, T> Debug for JoinHandle<R, T>

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

Formats the value using the given formatter.

impl<R, T> Drop for JoinHandle<R, T>

fn drop(&mut self)

Executes the destructor for this type.

impl<R, T> Future for JoinHandle<R, T>

type Output = Option<R>

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.

impl<R: Send, T> Send for JoinHandle<R, T>

impl<R, T> Sync for JoinHandle<R, T>

impl<R, T> Unpin for JoinHandle<R, T>