Struct dodrio::Vdom

#[must_use =
  "A `Vdom` will only keep rendering and listening to events while it has not been \
              dropped. If you want a `Vdom` to run forever, call `Vdom::forget`."]pub struct Vdom { /* fields omitted */ }

A strong handle to a mounted virtual DOM.

When this handle is dropped, the virtual DOM is unmounted and its listeners removed. To keep it mounted forever, use the Vdom::forget method.

Implementations

impl Vdom

pub fn new<R>(container: &Element, component: R) -> Vdom where
    R: RootRender, 

Mount a new Vdom in the given container element with the given root rendering component.

This will box the given component into trait object.

pub fn with_boxed_root_render(
    container: &Element,
    component: Box<dyn RootRender>
) -> Vdom

Construct a Vdom with the already-boxed-as-a-trait-object root rendering component.

pub fn forget(self)

Run this virtual DOM and its listeners forever and never unmount it.

pub fn weak(&self) -> VdomWeak

Get a weak handle to this virtual DOM.

pub fn unmount(self) -> Box<dyn RootRender>

Unmount this virtual DOM, unregister its event listeners, and return its root render component.

Trait Implementations

impl Debug for Vdom

fn fmt(&self, f: &mut Formatter) -> Result

Formats the value using the given formatter.