Struct TaskValue 

pub struct TaskValue(/* private fields */);

A task as a value that can be stored in a property and streamed by a binding with the ^ operator: the handle to the eventual outcome of an asynchronous operation, which is an untyped result or an error. It has identity equality.

The outcome is produced by a TaskValueSource, by a future running on the dispatcher (TaskValue::run) or is known up front (TaskValue::from_result, TaskValue::from_exception).

Implementations

impl TaskValue

pub fn from_result<T: PropertyValue>(value: T) -> Self

A task that has completed with value.

pub fn from_untyped_result(value: Option<BoxedValue>) -> Self

A task that has completed with an untyped value: null, a boxed value or a shared model object.

pub fn from_exception(error: BindingError) -> Self

A task that has failed with error.

pub fn run<F>(future: F) -> Self

where F: Future<Output = Result<Option<BoxedValue>, BindingError>> + 'static,

Runs future on the dispatcher of the calling thread and returns the task for its outcome. A future that is dropped before it completes (the dispatcher shut down, the future panicked) leaves the task running forever.

pub fn is_completed(&self) -> bool

Whether the task has finished: completed or failed.

pub fn is_completed_successfully(&self) -> bool

Whether the task ran to completion.

pub fn is_faulted(&self) -> bool

Whether the task failed.

pub fn result(&self) -> Option<Result<Option<BoxedValue>, BindingError>>

The outcome of the task, if it has finished.

pub fn continue_with(&self, continuation: impl FnOnce() + 'static)

Runs continuation when the task finishes; right away if it has finished already. The continuation runs where the task is completed: a caller that needs it on the dispatcher posts from it.

Trait Implementations

impl Clone for TaskValue

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl PartialEq for TaskValue

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

Equality operator ==.

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

Inequality operator !=.