Struct relm4::RelmComponent

pub struct RelmComponent<Model, ParentModel>where
    Model: ComponentUpdate<ParentModel> + 'static,
    ParentModel: ModelTrait,
    Model::Widgets: WidgetsTrait<Model, ParentModel> + 'static,{ /* private fields */ }

A component that can be part of the main application or other components.

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

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

Implementations

impl<Model, ParentModel> RelmComponent<Model, ParentModel>where Model::Widgets: WidgetsTrait<Model, ParentModel> + 'static, ParentModel: ModelTrait, Model: ComponentUpdate<ParentModel> + 'static,

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

Create a new RelmComponent.

pub fn connect_parent(&mut self, parent_widgets: &ParentModel::Widgets)

Connect the widgets to the widgets of the parent widget.

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 component.

pub fn sender(&self) -> Sender<Model::Msg>

Get a sender to send messages to this component.

pub fn root_widget( &self ) -> &<Model::Widgets as WidgetsTrait<Model, ParentModel>>::Root

Returns the root widget of this component’s widgets. Can be used by the parent to connect the root widget to the parent’s widgets.

pub fn widgets(&self) -> Option<RefMut<'_, Model::Widgets>>

Returns a mutable reference to the widgets of this component or None if you already have a reference to the widgets.

Use this carefully and make sure the reference to the widgets is dropped after use because otherwise the view function can’t be called as long you own the widgets (it uses RefCell internally).

Trait Implementations

impl<Model, ParentModel> Debug for RelmComponent<Model, ParentModel>where Model: ComponentUpdate<ParentModel> + 'static + Debug, ParentModel: ModelTrait + Debug, Model::Widgets: WidgetsTrait<Model, ParentModel> + 'static + Debug, Model::Components: Debug, Model::Msg: Debug,

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

Formats the value using the given formatter.