Struct UiTask 

pub struct UiTask<R>(/* private fields */);

Represents a Future running in sync with the UI.

The future Waker, wakes the app event loop and causes an update, in an update handler of the task owner update is called, if this task waked the app the future is polled once.

Implementations

impl<R> UiTask<R>

pub fn new_raw<F>( event_loop_waker: Waker, task: impl IntoFuture<IntoFuture = F>, ) -> UiTask<R>

where F: Future<Output = R> + Send + 'static,

New task with already build event-loop waker.

App crate provides an integrated UiTaskWidget::new that creates the waker for widgets.

pub fn new_raw_boxed( event_loop_waker: Waker, task: Pin<Box<dyn Future<Output = R> + Send>>, ) -> UiTask<R>

Like like new_raw with already boxed and pinned future.

pub fn update(&mut self) -> Option<&R>

Polls the future if needed, returns a reference to the result if the task is done.

This does not poll the future if the task is done.

App Update

This method must be called only once per app update, if it is called more than once it will cause execution bugs, futures like task::yield_now will not work correctly, variables will have old values when a new one is expected and any other number of hard to debug issues will crop-up.

In debug builds this is validated and an error message is logged if incorrect updates are detected.

pub fn is_ready(&self) -> bool

Returns true if the task is done.

This does not poll the future.

pub fn into_result(self) -> Result<R, UiTask<R>>

Returns the result if the task is completed.

This does not poll the future, you must call update to poll until a result is available, then call this method to take ownership of the result.

pub fn cancel(self)

Drop the task without logging a warning if it is pending.

Trait Implementations

impl<R> Debug for UiTask<R>

where R: Debug,

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

Formats the value using the given formatter.

impl<R> Drop for UiTask<R>

fn drop(&mut self)

Executes the destructor for this type.

impl<R> IntoFuture for UiTask<R>

where R: Send + 'static,

type Output = R

The output that the future will produce on completion.

type IntoFuture = Pin<Box<dyn Future<Output = R> + Send>>

Which kind of future are we turning this into?

fn into_future(self) -> <UiTask<R> as IntoFuture>::IntoFuture

Creates a future from a value.

impl<R> UiTaskWidget<R> for UiTask<R>

fn new<F>( target: Option<WidgetId>, task: impl IntoFuture<IntoFuture = F>, ) -> UiTask<R>

where F: Future<Output = R> + Send + 'static,

Create a UI bound future executor.

fn new_boxed( target: Option<WidgetId>, task: Pin<Box<dyn Future<Output = R> + Send>>, ) -> UiTask<R>

Like new, from an already boxed and pinned future.