Struct relm4::RelmWorker

pub struct RelmWorker<Model, ParentModel> where
    Model: ComponentUpdate<ParentModel, Widgets = ()> + 'static,
    ParentModel: ModelTrait,  { /* private fields */ }

RelmWorkers are like RelmComponents but they don’t have any widgets.

They are usually used to run expansive tasks on different threads and report back when they are finished so that their parent components can keep handling UI events in the meantime. For example you could use a RelmWorker for sending a HTTP request or for copying files.

A RelmWorker has its own model and message type and can send messages to its parent and its children components.

Multiple RelmWorkers that have the same parent are usually bundled along with RelmComponents in a struct that implements Components.

Implementations

impl<Model, ParentModel> RelmWorker<Model, ParentModel> where
    Model: ComponentUpdate<ParentModel, Widgets = ()> + 'static,
    ParentModel: ModelTrait, 

pub fn new(
    parent_model: &ParentModel,
    parent_sender: Sender<ParentModel::Msg>
) -> Self

Create a new RelmWorker that runs on the main thread.

pub fn send(&self, msg: Model::Msg) -> Result<(), SendError<Model::Msg>>

Send a message to this component. This can be used by the parent to send messages to this worker.

impl<Model, ParentModel> RelmWorker<Model, ParentModel> where
    Model: ComponentUpdate<ParentModel, Widgets = ()> + Send + 'static,
    Model::Components: Send + 'static,
    Model::Msg: Send,
    ParentModel: ModelTrait,
    ParentModel::Msg: Send, 

pub fn with_new_thread(
    parent_model: &ParentModel,
    parent_sender: Sender<ParentModel::Msg>
) -> Self

Create a new RelmWorker that runs the ComponentUpdate::update function in another thread.

Trait Implementations

impl<Model: Clone, ParentModel: Clone> Clone for RelmWorker<Model, ParentModel> where
    Model: ComponentUpdate<ParentModel, Widgets = ()> + 'static,
    ParentModel: ModelTrait,
    Model::Msg: Clone, 

fn clone(&self) -> RelmWorker<Model, ParentModel>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Model: Debug, ParentModel: Debug> Debug for RelmWorker<Model, ParentModel> where
    Model: ComponentUpdate<ParentModel, Widgets = ()> + 'static,
    ParentModel: ModelTrait,
    Model::Msg: Debug, 

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

Formats the value using the given formatter.