Struct JobHandle

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

Reference to a Future that has been scheduled via send

Dropping a JobHandle cancels it, which means its future won’t be polled again. To drop the JobHandle handle without canceling it, use detach() instead. To cancel a task gracefully and wait until it is fully destroyed, use the cancel() method

This type implements Future to allow awaiting on the result of the spawned task

Implementations

impl<T> JobHandle<T>

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

Cancels the task and waits for it to stop running.

Returns the task’s output if it was completed just before it got canceled, or None if it didn’t complete.

While it’s possible to simply drop the JobHandle to cancel it, this is a cleaner way of canceling because it also waits for the task to stop running.

pub fn detach(self)

Detaches the task to let it keep running in the background.

pub fn is_complete(&self) -> bool

Check whether this job has completed

Trait Implementations

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