Struct sauron_core::dom::cmd::Cmd

pub struct Cmd<APP, MSG>where
    MSG: 'static,{
    pub commands: Vec<Box<dyn FnOnce(Program<APP, MSG>)>>,
    /* private fields */
}

Cmd is a command to be executed by the system. This is returned at the init function of a component and is executed right after instantiation of that component. Cmd required a DSP object which is the Program as an argument The emit function is called with the program argument. The callback is supplied with the program an is then executed/emitted.

Fields

commands: Vec<Box<dyn FnOnce(Program<APP, MSG>)>>

the functions that would be executed when this Cmd is emited

Implementations

impl<APP, MSG> Cmd<APP, MSG>where MSG: 'static, APP: Application<MSG> + 'static,

pub fn new<F>(f: F) -> Selfwhere F: FnOnce(Program<APP, MSG>) + 'static,

creates a new Cmd from a function

pub fn batch(cmds: impl IntoIterator<Item = Self>) -> Self

When you need the runtime to perform couple of commands, you can batch then together.

pub fn push(&mut self, cmd: Self)

Add a cmd

pub fn append(&mut self, cmds: impl IntoIterator<Item = Self>)

Append more cmd into this cmd and return self

pub fn none() -> Self

Tell the runtime that there are no commands.

pub fn should_update_view(self, should_update_view: bool) -> Self

Modify the Cmd such that whether or not it will update the view set by should_update_view when the cmd is executed in the program

pub fn no_render(self) -> Self

Modify the command such that it will not do an update on the view when it is executed.

pub fn measure(self) -> Self

Modify the command such that it will log measurement when it is executed

pub fn measure_with_name(self, name: &str) -> Self

Modify the Cmd such that it will log a measuregment when it is executed The measurement_name is set to distinguish the measurements from each other.

pub fn emit(self, program: &Program<APP, MSG>)

Executes the Cmd

pub fn batch_msg(msg_list: impl IntoIterator<Item = MSG>) -> Self

Tell the runtime to execute subsequent update of the App with the message list. A single call to update the view is then executed thereafter.

Trait Implementations

impl<APP, MSG> From<Effects<MSG, ()>> for Cmd<APP, MSG>where MSG: 'static, APP: Application<MSG> + 'static,

fn from(effects: Effects<MSG, ()>) -> Self

Convert Effects that has only follow ups

impl<APP, MSG> From<Vec<Effects<MSG, ()>, Global>> for Cmd<APP, MSG>where MSG: 'static, APP: Application<MSG> + 'static,

fn from(effects: Vec<Effects<MSG, ()>>) -> Self

Converts to this type from the input type.