Struct TaskHandle 

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

A task of the dispatcher of the user interface, held as an untyped value (Task<T>).

Clones refer to the same task and compare equal; the result of the task can be taken once (awaiting it takes it).

Implementations

impl<T: 'static> TaskHandle<T>

pub fn spawn<Fut>(future: Fut) -> Self

where Fut: Future<Output = T> + 'static,

Runs future on the dispatcher of the user interface and returns its task (Dispatcher.UIThread.InvokeAsync(async () => ..)). The future starts in a job of the dispatcher.

Panics

Panics when called from a thread other than the thread of the user interface.

pub fn from_task(task: DispatcherTask<T>) -> Self

The handle of an existing dispatcher task.

pub fn task(&self) -> &DispatcherTask<T>

The dispatcher task.

pub fn is_completed(&self) -> bool

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

pub fn is_completed_successfully(&self) -> bool

Whether the task ran to the end (IsCompletedSuccessfully).

pub fn is_faulted(&self) -> bool

Whether the future of the task panicked (IsFaulted).

pub fn is_canceled(&self) -> bool

Whether the task was canceled (IsCanceled).

impl TaskHandle<()>

pub fn completed() -> Self

A task that has already completed (Task.CompletedTask).

Trait Implementations

impl<T: 'static> Clone for TaskHandle<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: 'static> Debug for TaskHandle<T>

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

Formats the value using the given formatter.

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

impl<T: 'static> PartialEq for TaskHandle<T>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.