Struct dreadnought::task::JoinableAsyncTaskRef

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

An owned permission to join an async task.

Implementations

impl<T> JoinableAsyncTaskRef<T>

pub fn abort(&self)

Abort the task associated with the handle.

If the cancelled task was already completed at the time it was cancelled, it will return the successful result. Otherwise, polling the handle will fail with an Error::Cancelled.

Warning

This uses [Task::kill] and so the aborted task isn’t unwound.

pub fn is_finished(&self) -> bool

Returns whether the task associated with the handle has finished.

Trait Implementations

impl<T> Future for JoinableAsyncTaskRef<T>where T: 'static,

type Output = Result<T, Error>

The type of value produced on completion.

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

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