Struct sauron_core::dom::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: Application<MSG> + 'static, 

pub fn new(app: APP, mount_node: &Node, replace: bool, use_shadow: bool) -> Self

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

pub fn root_node(&self) -> Node

get the real DOM node where this app is mounted to.

pub fn mount_node(&self) -> Node

return the node where the app is mounted into

pub fn replace_mount(app: APP, mount_node: &Node) -> Self

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

Example

struct App{}
let mount = document().query_selector(".container").ok().flatten().unwrap();
Program::replace_mount(App{}, &mount);

pub fn append_to_mount(app: APP, mount_node: &Node) -> Self

Instantiage an app and append the view to the root_node

Example

struct App{}
let mount = document().query_selector("#app").ok().flatten().unwrap();
Program::append_to_mount(App{}, &mount);

pub fn mount_to_body(app: APP) -> Self

Instantiate the app and then append it to the document body

Example

struct App{}
Program::mount_to_body(App{});

pub fn mount(&self)

Do the actual mounting of the view to the specified mount node

pub fn update_dom(&self)

explicity update the dom

pub fn update_mount_attributes(&self, attributes_value: BTreeMap<String, String>)

update the attributes at the mounted element

pub fn inject_style_to_mount(&self, style: &str)

Inject a style to the mount node

Trait Implementations

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

fn clone(&self) -> Self

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: Application<MSG> + 'static, 

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

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.