Struct sauron::prelude::prelude::Dispatch

pub struct Dispatch<APP>
where
    APP: Application,
{ /* private fields */ }

Dispatch 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. Dispatch 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.

Implementations

impl<APP> Dispatch<APP>

where APP: Application,

pub fn new<F>(f: F) -> Dispatch<APP>

where F: FnOnce(Program<APP>) + 'static,

creates a new Dispatch from a function

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

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

pub fn push(&mut self, cmd: Dispatch<APP>)

Add a cmd

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

Append more cmd into this cmd and return self

pub fn none() -> Dispatch<APP>

Tell the runtime that there are no commands.

pub fn is_empty(&self) -> bool

returns true if commands is empty

pub fn batch_msg( msg_list: impl IntoIterator<Item = <APP as Application>::MSG> ) -> Dispatch<APP>

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> From<Cmd<<APP as Application>::MSG>> for Dispatch<APP>

where APP: Application,

fn from(task: Cmd<<APP as Application>::MSG>) -> Dispatch<APP>

Converts to this type from the input type.

impl<APP> From<Effects<<APP as Application>::MSG, ()>> for Dispatch<APP>

where APP: Application,

fn from(effects: Effects<<APP as Application>::MSG, ()>) -> Dispatch<APP>

Convert Effects that has only follow ups

impl<APP, IN> From<IN> for Dispatch<APP>

where APP: Application, IN: IntoIterator<Item = Effects<<APP as Application>::MSG, ()>>,

fn from(effects: IN) -> Dispatch<APP>

Converts to this type from the input type.