Struct JoinHandle

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

A handle that awaits the result of a task.

Dropping a JoinHandle will detach the task, meaning that there is no longer a handle to the task and no way to join on it.

Created when a task is spawned.

Implementations

impl<T> JoinHandle<T>

pub fn task(&self) -> &Task

Returns a handle to the underlying task.

Examples

use async_std::task;

let handle = task::spawn(async {
    1 + 2
});
println!("id = {}", handle.task().id());

pub async fn cancel(self) -> Option<T>

Cancel this task.

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> 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>

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