Struct sauron::cmd::Cmd

pub struct Cmd<DSP> {
    pub commands: Vec<Rc<dyn Fn(DSP) + 'static>, Global>,
    pub should_update_view: 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<Rc<dyn Fn(DSP) + 'static>, Global>

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

Implementations

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

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

creates a new Cmd from a function

pub fn batch(cmds: Vec<Cmd<DSP>, Global>) -> Cmd<DSP>

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

pub fn none() -> Cmd<DSP>

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) -> Cmd<DSP>

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

pub fn no_render() -> Cmd<DSP>

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