Trait relm4::factory::FactoryComponent

pub trait FactoryComponent: Position<<Self::ParentWidget as FactoryView>::Position> + Sized + 'static {
    type ParentWidget: FactoryView + 'static;
    type ParentInput: Debug + 'static;
    type CommandOutput: Debug + Send + 'static;
    type Input: Debug + 'static;
    type Output: Debug + 'static;
    type Init;
    type Root: AsRef<<Self::ParentWidget as FactoryView>::Children> + Debug + Clone;
    type Widgets: 'static;

    // Required methods
    fn init_model(
        init: Self::Init,
        index: &DynamicIndex,
        sender: FactorySender<Self>
    ) -> Self;
    fn init_root(&self) -> Self::Root;
    fn init_widgets(
        &mut self,
        index: &DynamicIndex,
        root: &Self::Root,
        returned_widget: &<Self::ParentWidget as FactoryView>::ReturnedWidget,
        sender: FactorySender<Self>
    ) -> Self::Widgets;

    // Provided methods
    fn output_to_parent_input(
        _output: Self::Output
    ) -> Option<Self::ParentInput> { ... }
    fn update(&mut self, message: Self::Input, sender: FactorySender<Self>) { ... }
    fn update_cmd(
        &mut self,
        message: Self::CommandOutput,
        sender: FactorySender<Self>
    ) { ... }
    fn update_cmd_with_view(
        &mut self,
        widgets: &mut Self::Widgets,
        message: Self::CommandOutput,
        sender: FactorySender<Self>
    ) { ... }
    fn update_view(
        &self,
        widgets: &mut Self::Widgets,
        sender: FactorySender<Self>
    ) { ... }
    fn update_with_view(
        &mut self,
        widgets: &mut Self::Widgets,
        message: Self::Input,
        sender: FactorySender<Self>
    ) { ... }
    fn shutdown(
        &mut self,
        widgets: &mut Self::Widgets,
        output: Sender<Self::Output>
    ) { ... }
    fn id(&self) -> String { ... }
}

A component that’s stored inside a factory. Similar to Component but adjusted to fit the life cycle of factories.

Required Associated Types

type ParentWidget: FactoryView + 'static

Container widget to which all widgets of the factory will be added.

type ParentInput: Debug + 'static

Input messages sent to the parent component.

type CommandOutput: Debug + Send + 'static

Messages which are received from commands executing in the background.

type Input: Debug + 'static

The message type that the factory component accepts as inputs.

type Output: Debug + 'static

The message type that the factory component provides as outputs.

type Init

The parameter used to initialize the factory component.

type Root: AsRef<<Self::ParentWidget as FactoryView>::Children> + Debug + Clone

The widget that was constructed by the factory component.

type Widgets: 'static

The type that’s used for storing widgets created for this factory component.

Required Methods

fn init_model( init: Self::Init, index: &DynamicIndex, sender: FactorySender<Self> ) -> Self

Initializes the model.

fn init_root(&self) -> Self::Root

Initializes the root widget

fn init_widgets( &mut self, index: &DynamicIndex, root: &Self::Root, returned_widget: &<Self::ParentWidget as FactoryView>::ReturnedWidget, sender: FactorySender<Self> ) -> Self::Widgets

Initializes the widgets.

Provided Methods

fn output_to_parent_input(_output: Self::Output) -> Option<Self::ParentInput>

Optionally convert an output message from this component to an input message for the parent component. By default this method does nothing, you must overwrite it to forward messages.

If None is returned, nothing is forwarded.

fn update(&mut self, message: Self::Input, sender: FactorySender<Self>)

Processes inputs received by the component.

fn update_cmd( &mut self, message: Self::CommandOutput, sender: FactorySender<Self> )

Defines how the component should respond to command updates.

fn update_cmd_with_view( &mut self, widgets: &mut Self::Widgets, message: Self::CommandOutput, sender: FactorySender<Self> )

Handles updates from a command.

fn update_view(&self, widgets: &mut Self::Widgets, sender: FactorySender<Self>)

Updates the view after the model has been updated.

fn update_with_view( &mut self, widgets: &mut Self::Widgets, message: Self::Input, sender: FactorySender<Self> )

Updates the model and view. Optionally returns a command to run.

fn shutdown( &mut self, widgets: &mut Self::Widgets, output: Sender<Self::Output> )

Last method called before a component is shut down.

fn id(&self) -> String

An identifier for the component used for debug logging.

The default implementation of this method uses the address of the component, but implementations are free to provide more meaningful identifiers.

Implementors