Struct sauron::cmd::Cmd

pub struct Cmd<DSP> {
    pub commands: Vec<Callback<DSP, ()>, Global>,
    // some fields omitted
}

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, ()>, Global>

the functions that would be executed when this Cmd is emited

Implementations

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

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

creates a new Cmd from a function

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

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

pub fn append(self, cmds: impl IntoIterator<Item = Cmd<DSP>>) -> Cmd<DSP>

Append more cmd into this cmd and return self

pub fn none() -> Cmd<DSP>

A Cmd with no callback, similar to NoOp.

pub fn should_update_view(self, should_update_view: bool) -> Cmd<DSP>

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

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

pub fn measure(self) -> Cmd<DSP>

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

pub fn measure_with_name(self, name: &str) -> Cmd<DSP>

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.

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

pub fn emit(self, program: &DSP)

Executes the Cmd

impl<DSP> Cmd<DSP>

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

batch dispatch this msg on the next update loop

Trait Implementations

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

pub 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: 'static + Clone,
    DSP: 'static + Dispatch<MSG> + Clone, 

pub fn from(effects: Effects<MSG, ()>) -> Cmd<DSP>

Convert Effects that has only follow ups