Struct sauron::DomUpdater

pub struct DomUpdater<MSG> {
    pub current_vdom: Node<&'static str, &'static str, &'static str, AttributeValue, Event, MSG>,
    pub root_node: Node,
    pub active_closures: HashMap<u32, Vec<(&'static str, Closure<dyn FnMut(Event) + 'static>), Global>, RandomState>,
    pub focused_node: Option<Node>,
}

Used for keeping a real DOM node up to date based on the current Node and a new incoming Node that represents our latest DOM state.

Fields

current_vdom: Node<&'static str, &'static str, &'static str, AttributeValue, Event, MSG>

the current vdom representation

root_node: Node

the equivalent actual DOM element where the App is mounted into

active_closures: HashMap<u32, Vec<(&'static str, Closure<dyn FnMut(Event) + 'static>), Global>, RandomState>

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

focused_node: Option<Node>

after mounting or update dispatch call, the element will be focused

Implementations

impl<MSG> DomUpdater<MSG>

pub fn new(
    current_vdom: Node<&'static str, &'static str, &'static str, AttributeValue, Event, MSG>,
    mount: &Node
) -> DomUpdater<MSG>

Creates and instance of this DOM updater, but doesn't mount the current_vdom to the DOM just yet.

pub fn active_closure_len(&self) -> usize

count the total active closures regardless of which element it attached to.

impl<MSG> DomUpdater<MSG> where
    MSG: 'static, 

pub fn append_to_mount<DSP>(&mut self, program: &DSP) where
    DSP: Dispatch<MSG> + Clone + 'static, 

Mount the current_vdom appending to the actual browser DOM specified in the root_node This also gets the closures that was created when mounting the vdom to their actual DOM counterparts.

pub fn replace_mount<DSP>(&mut self, program: &DSP) where
    DSP: Dispatch<MSG> + Clone + 'static, 

Mount the current_vdom replacing the actual browser DOM specified in the root_node This also gets the closures that was created when mounting the vdom to their actual DOM counterparts.

pub fn new_append_to_mount<DSP>(
    program: &DSP,
    current_vdom: Node<&'static str, &'static str, &'static str, AttributeValue, Event, MSG>,
    mount: &Element
) -> DomUpdater<MSG> where
    DSP: Dispatch<MSG> + Clone + 'static, 

Create a new DomUpdater.

A root Node will be created and appended (as a child) to your passed in mount element.

pub fn new_replace_mount<DSP>(
    program: &DSP,
    current_vdom: Node<&'static str, &'static str, &'static str, AttributeValue, Event, MSG>,
    mount: Element
) -> DomUpdater<MSG> where
    DSP: Dispatch<MSG> + Clone + 'static, 

Create a new DomUpdater.

A root Node will be created and it will replace your passed in mount element.

pub fn update_dom<DSP>(
    &mut self,
    program: &DSP,
    new_vdom: Node<&'static str, &'static str, &'static str, AttributeValue, Event, MSG>
) where
    DSP: Dispatch<MSG> + Clone + 'static, 

Diff the current virtual dom with the new virtual dom that is being passed in.

Then use that diff to patch the real DOM in the user's browser so that they are seeing the latest state of the application.

pub fn patch_dom<DSP>(
    &mut self,
    program: &DSP,
    patches: Vec<Patch<'_, &'static str, &'static str, &'static str, AttributeValue, Event, MSG>, Global>
) where
    DSP: Dispatch<MSG> + Clone + 'static, 

Apply patches to the dom updater Warning: only used this for debuggin purposes

pub fn map_msg<F, MSG2>(self, func: F) -> DomUpdater<MSG2> where
    F: Fn(MSG) -> MSG2 + 'static,
    MSG2: 'static, 

map this DomUpdater such that the Node will become Node

pub fn root_node(&self) -> Node

Return the root node of your application, the highest ancestor of all other nodes in your real DOM tree.