Struct sauron_core::dom::Program

pub struct Program<APP, MSG>where
    MSG: 'static,{
    pub app: Rc<RefCell<APP>>,
    pub active_closures: Rc<RefCell<BTreeMap<usize, Vec<(&'static str, Closure<dyn FnMut(Event)>)>>>>,
    /* private fields */
}

Program handle the lifecycle of the APP

Fields

app: Rc<RefCell<APP>>

holds the user application

active_closures: Rc<RefCell<BTreeMap<usize, Vec<(&'static str, Closure<dyn FnMut(Event)>)>>>>

The closures that are currently attached to elements in the page.

We keep these around so that they don’t get dropped (and thus stop working);

Implementations

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

pub fn new( app: APP, mount_node: &Node, action: MountAction, target: MountTarget ) -> 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 mount_node(&self) -> Node

return the node where the app is mounted into

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 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 clear_append_to_mount(app: APP, mount_node: &Node) -> Self

clear the existing children of the mount first before appending

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)

each element and it’s descendant in the vdom is created into an actual DOM node.

pub fn update_dom(&self) -> Result<Measurements, JsValue>

update the browser DOM to reflect the APP’s view

pub fn update_dom_with_vdom( &self, new_vdom: Node<MSG> ) -> Result<usize, JsValue>

patch the DOM to reflect the App’s view

pub fn set_current_dom(&self, new_vdom: Node<MSG>)

replace the current vdom with the new_vdom.

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

inject style element to the mount node

impl<APP, MSG> 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

pub fn dispatch_multiple(&self, msgs: impl IntoIterator<Item = MSG>)

dispatch multiple MSG

pub fn dispatch(&self, msg: MSG)

dispatch a single msg

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.