Struct UiRunner

pub struct UiRunner<T> { /* private fields */ }

Run code on the UI thread from another thread.

Allows you to mix non-blocking threaded code, with code that reads and updates your widget in the UI thread.

This can be copied and passed around.

Implementations

impl<T: 'static> UiRunner<T>

pub fn new(key: usize) -> Self

Create a new UiRunner that dispatches functions as global actions but differentiates them by the provided key.

If used in a widget, prefer using your_widget.ui_runner(). If used in your app main, prefer using your_app_main.ui_runner().

pub fn handle( self, cx: &mut Cx, event: &Event, scope: &mut Scope<'_, '_>, target: &mut T, )

Handle all functions scheduled with the key of this UiRunner.

You should call this once from your handle_event method, like:

fn handle_event(&mut self, cx: &mut Cx, event: &Event, scope: &mut Scope) {
   // ... handle other stuff ...
   self.ui_runner().handle(cx, event, scope, self);
}

Once a function has been handled, it will never run again.

pub fn defer(self, f: impl DeferCallback<T>)

Schedule the provided closure to run on the UI thread.

pub fn block_on<R: Send + 'static>( self, f: impl FnOnce(&mut T, &mut Cx, &mut Scope<'_, '_>) -> R + Send + 'static, ) -> R

Like defer, but blocks the current thread until the UI awakes, processes the closure, and returns the result.

Generally, you should prefer to use defer if you don’t need to communicate a value back. This method may wait a long time if the UI thread is busy so you should not use it in tight loops.

Trait Implementations

impl<T> Clone for UiRunner<T>

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<T> Debug for UiRunner<T>

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

Formats the value using the given formatter.

impl<T> PartialEq for UiRunner<T>

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<T> Copy for UiRunner<T>