Struct sauron_core::dom::cmd::Cmd

pub struct Cmd<DSP> {
    pub commands: Vec<Callback<DSP, ()>>,
    pub should_update_view: bool,
    pub log_measurements: bool,
}

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<Callback<DSP, ()>>

the functions that would be executed when this Cmd is emited

should_update_view: bool

this instruct the program whether or not to update the view

log_measurements: bool

tell the cmd to log the measurements of not. set only to true for a certain MSG where you want to measure the performance in the component update function. Otherwise, measurement calls for other non-trivial functions are also called causing on measurements.

Implementations

impl<DSP> Cmd<DSP> where
    DSP: Clone + 'static, 

pub fn new<F>(f: F) -> Self where
    F: Fn(DSP) + 'static, 

creates a new Cmd from a function

pub fn batch(cmds: Vec<Self>) -> Self

creates a unified Cmd which batches all the other Cmds in one.

pub fn none() -> Self

A Cmd with no callback, similar to NoOp.

pub fn emit(self, program: &DSP)

Executes the Cmd

pub fn should_update_view(should_update_view: bool) -> Self

Creates an empty Cmd and specifies that there is NO update will be made to the view.

pub fn no_render() -> Self

Create a cmd which instruct the program that there is NO update will be made to the view

pub fn measure() -> Self

Create a cmd which instruct the program that it should log the measurements for each part of the dispatch process.

impl<DSP> Cmd<DSP>

pub fn batch_msg<MSG>(msg_list: Vec<MSG>) -> Self where
    MSG: Clone + 'static,
    DSP: Dispatch<MSG> + Clone + 'static, 

batch dispatch this msg on the next update loop

pub fn map_msg<F, PMSG, MSG>(effects: Effects<MSG, PMSG>, f: F) -> Self where
    DSP: Dispatch<PMSG> + Clone + 'static,
    MSG: Clone + 'static,
    PMSG: Clone + 'static,
    F: Fn(MSG) -> PMSG + 'static, 

Convert effects into Cmd

pub fn from_effects<MSG>(effects: Effects<MSG, MSG>) -> Self where
    MSG: Clone + 'static,
    DSP: Dispatch<MSG> + Clone + 'static, 

Create a Cmd from effects that has follow_ups and effects are both Vec

Trait Implementations

impl<DSP: Clone> Clone for Cmd<DSP>

fn clone(&self) -> Cmd<DSP>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<DSP, MSG> From<Effects<MSG, ()>> for Cmd<DSP> where
    MSG: Clone + 'static,
    DSP: Dispatch<MSG> + Clone + 'static, 

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

Convert Effects that has only follow ups