Struct Task 

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

A spawned task.

Awaiting it gives the task’s output. Dropping it cancels the task: its future is dropped without being polled again. detach lets the task run to its end without a handle.

If the task’s future panics, awaiting the handle resumes the panic.

Panics

Awaiting a task that was cancelled before it completed (through an AbortHandle, or by its runtime’s shutdown) panics; join answers a JoinError instead, and fallible gives a handle that returns None.

Implementations

impl<T> Task<T>

pub fn detach(self)

Lets the task run to its end without a handle; its output is dropped.

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

Cancels the task and waits for its future to be dropped. Returns the output if the task had already completed.

pub fn fallible(self) -> FallibleTask<T>

A handle that returns None where this one panics: when the task was cancelled, or its runtime dropped it before it completed.

pub fn is_finished(&self) -> bool

Whether the task completed or was cancelled. Awaiting a finished task returns at once.

pub fn id(&self) -> Id

The task’s id.

pub fn abort(&self)

Cancels the task without waiting: its future is dropped where it runs, and awaiting the handle then finds no output (unless the task had completed). join reports it as a cancelled JoinError.

pub fn abort_handle(&self) -> AbortHandle

A handle that cancels the task from anywhere, without the Task: it can be cloned and sent to another thread, and outlives the handle.

pub fn join(self) -> Join<T>

A future that gives the task’s output, or a JoinError saying why there is none: the task was cancelled (its runtime dropped it too), or its future panicked, with the payload.

Trait Implementations

impl<T> Debug for Task<T>

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

Formats the value using the given formatter.

impl<T> Drop for Task<T>

fn drop(&mut self)

Executes the destructor for this type.

fn pin_drop(self: Pin<&mut Self>)

🔬This is a nightly-only experimental API. (pin_ergonomics)

Execute the destructor for this type, but different to Drop::drop, it requires self to be pinned.

impl<T> Future for Task<T>

type Output = T

The type of value produced on completion.

fn poll(self: Pin<&mut Self>, cx: &mut Context<'_>) -> Poll<T>

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

impl<T> RefUnwindSafe for Task<T>

impl<T: Send> Send for Task<T>

impl<T> Sync for Task<T>

impl<T> Unpin for Task<T>

impl<T> UnwindSafe for Task<T>