Struct components::engine::d2::util::Promise

pub struct Promise<A> {
    pub has_result: bool,
    pub success: Signal1<A>,
    pub error: Signal1<String>,
    pub progress_changed: Signal0,
    pub result: Option<A>,
    pub progress: f32,
    pub total: f32,
}

Represents a value that isn’t ready yet, but may become available in the future.

Fields

has_result: bool

Whether the result is available yet.

success: Signal1<A>

Emitted when the promise is fulfilled and the result has become available.

error: Signal1<String>

An error message emitted if there was a problem during loading.

progress_changed: Signal0

May be emitted during loading when the progress or total counts have been updated.

result: Option<A>

The end result fulfilled by the promise. When accessing, throws an error if the result is not yet available. Read hasResult to check availability first, or use get(). When setting, throws an error if the result was already previously assigned.

progress: f32

Context on how close this promise is to being fulfilled. For file IO, these are in bytes.

total: f32

Implementations

impl<A> Promise<A>

pub fn new() -> Promise<A>

pub fn result(&self) -> &Option<A>

pub fn set_result(&self, result: Option<A>) -> Option<A>

pub fn get(
    &self,
    function: Box<dyn Fn(&A) + 'static, Global>
) -> Option<impl Disposable>

Passes the result to the callback now if the result is available, otherwise calls it later. @returns If the callback was not called yet, a handle that can be disposed to cancel the request.

pub fn progress(&self) -> f32

pub fn set_progress(&mut self, progress: f32)

pub fn set_total(&mut self, total: f32)

pub fn total(&self) -> f32

Trait Implementations

impl AsRef<Promise<Vec<Dynamic, Global>>> for MultiPromise

fn as_ref(&self) -> &Promise<Vec<Dynamic, Global>>

Converts this type into a shared reference of the (usually inferred) input type.