Struct TaskHandle

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

An owned permission to cancel task on Drop besides join and cancel on demand.

Implementations

impl<T> TaskHandle<T>

pub fn id(&self) -> Id

Gets id of associated task.

Cautions

See cautions of Id.

pub fn detach(self) -> JoinHandle<T>

Detaches task from permission to cancel on Drop.

pub fn cancel(self) -> JoinHandle<T>

Cancels owning task.

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 cancel_handle(&self) -> CancelHandle

Creates a handle to cancel associated task.

Trait Implementations

impl<T> Drop for TaskHandle<T>

fn drop(&mut self)

Executes the destructor for this type.

impl<T> Future for TaskHandle<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.