Struct sauron::Program

pub struct Program<APP, MSG> where
    MSG: 'static,  {
    pub app: Rc<RefCell<APP>>,
    pub dom_updater: Rc<RefCell<DomUpdater<MSG>>>,
}

Holds the user App and the dom updater This is passed into the event listener and the dispatch program will be called after the event is triggered.

Fields

app: Rc<RefCell<APP>>

holds the user application

dom_updater: Rc<RefCell<DomUpdater<MSG>>>

The dom_updater responsible to updating the actual document in the browser

Implementations

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

pub fn new(app: APP, root_node: &Node) -> Program<APP, MSG>

Create an Rc wrapped instance of program, initializing DomUpdater with the initial view and root node, but doesn’t mount it yet.

pub fn replace_mount(app: APP, root_node: &Node) -> Program<APP, MSG>

Creates an Rc wrapped instance of Program and replace the root_node with the app view

pub fn append_to_mount(app: APP, root_node: &Node) -> Program<APP, MSG>

Instantiage an app and append the view to the root_node

pub fn mount_to_body(app: APP) -> Program<APP, MSG>

Instantiate the app and then append it to the document body

pub fn replace_body(app: APP) -> Program<APP, MSG>

Replace the body of the document with the app

Trait Implementations

impl<APP, MSG> Clone for Program<APP, MSG> where
    MSG: 'static, 

fn clone(&self) -> Program<APP, MSG>

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<APP, MSG> Dispatch<MSG> for Program<APP, MSG> where
    MSG: 'static,
    APP: 'static + Application<MSG>, 

This will be called when the actual event is triggered. Defined in the DomUpdater::create_closure_wrap function

fn dispatch_multiple(&self, msgs: Vec<MSG, Global>)

dispatch multiple msg

fn dispatch(&self, msg: MSG)

Executes the implementing dispatch function. In this case the implementation is the Program which is responsible for executing the update functions using the msg supplied. A new view will then be created and it will be diff to the previous view which will produce patches. These patched will then be applied to the browser DOM.