Struct JoinHandle

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

Handle to join or cancel associated task.

Implementations

impl<T> JoinHandle<T>

pub fn id(&self) -> Id

Gets id of associated task.

Cautions

See cautions of Id.

pub fn cancel(&self)

Cancels associated task with this handle.

Cancellation is inherently concurrent with task execution. Currently, there is no guarantee about promptness, the task could even run to complete normally after cancellation.

pub fn attach(self) -> TaskHandle<T>

Attaches to associated task to gain cancel on Drop permission.

pub fn cancel_handle(&self) -> CancelHandle

Creates a handle to cancel associated task.

Trait Implementations

impl<T> Drop for JoinHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Future for JoinHandle<T>

type Output = Result<T, JoinError>

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.