Struct DispatcherTask 

pub struct DispatcherTask<T = ()> { /* private fields */ }

The outcome of a future running on a Dispatcher; what the reference implementation returns as a task object.

The handle can be cloned and sent to other threads. It is a Future that resolves to Ok(result) when the future has completed and to Err(OperationCanceledError) when it was dropped before completing (the dispatcher shut down, or the operation that was going to start it was aborted). A panic raised by the future is re-raised to whoever observes the outcome.

Implementations

impl<T: 'static> DispatcherTask<T>

pub fn dispatcher(&self) -> &Arc<Dispatcher>

The dispatcher the future runs on.

pub fn is_completed(&self) -> bool

Whether the task has finished: completed, failed or canceled.

pub fn is_completed_successfully(&self) -> bool

Whether the task ran to the end without panicking.

pub fn is_faulted(&self) -> bool

Whether the future panicked.

pub fn is_canceled(&self) -> bool

Whether the future was dropped before it completed.

pub fn wait(&self) -> Result<(), OperationCanceledError>

Blocks until the task has finished. Only supported on threads other than the dispatcher thread, unless the task has already finished.

Panics

Re-raises the panic of the future. Panics when the task is still running and the calling thread is the dispatcher thread.

pub fn result(&self) -> Result<T, OperationCanceledError>

Blocks like wait and takes the result.

Panics

See wait. Also panics when the result has already been taken, and when a result that is not Send is requested from another thread.

Trait Implementations

impl<T> Clone for DispatcherTask<T>

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T> Debug for DispatcherTask<T>

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

Formats the value using the given formatter.

impl<T: 'static> Future for DispatcherTask<T>

type Output = Result<T, OperationCanceledError>

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.