Struct dodrio::VdomWeak

pub struct VdomWeak { /* fields omitted */ }

A weak handle to a virtual DOM.

Does not prevent the virtual DOM from being unmounted: only keeping the original Vdom alive guarantees that.

A VdomWeak also gives you the capability to scheduling re-rendering (say after mutating the render component state).

Implementations

impl VdomWeak

pub async fn set_component(
    self,
    root: Box<dyn RootRender>
) -> Result<Box<dyn RootRender + 'static>, VdomDroppedError>

Replace the root rendering component with the new root.

Returns a future that resolves to the old root component.

pub async fn with_component<'_, F, T>(
    &'_ self,
    f: F
) -> Result<T, VdomDroppedError> where
    F: 'static + FnOnce(&mut dyn RootRender) -> T, 

Execute f with a reference to this virtual DOM's root rendering component.

To ensure exclusive access to the root rendering component, the invocation takes place on a new tick of the micro-task queue.

pub fn schedule_render(&self)

Schedule a render to occur during the next animation frame.

If you want a future that resolves after the render has finished, use render instead.

pub fn render(&self) -> impl Future<Output = Result<(), VdomDroppedError>>

Schedule a render to occur during the next animation frame and return a future that will complete once the render has finished.

If you don't want to do more things after the render completes, then use schedule_render instead of render.

Trait Implementations

impl Clone for VdomWeak

fn clone(&self) -> VdomWeak

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for VdomWeak

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

Formats the value using the given formatter.