Struct dioxus_core::Mutations

source ·
pub struct Mutations<'a> {
    pub subtree: usize,
    pub dirty_scopes: FxHashSet<ScopeId>,
    pub templates: Vec<Template<'a>>,
    pub edits: Vec<Mutation<'a>>,
}
Expand description

A container for all the relevant steps to modify the Real DOM

This object provides a bunch of important information for a renderer to use patch the Real Dom with the state of the VirtualDom. This includes the scopes that were modified, the templates that were discovered, and a list of changes in the form of a Mutation.

These changes are specific to one subtree, so to patch multiple subtrees, you’d need to handle each set separately.

Templates, however, apply to all subtrees, not just target subtree.

Mutations are the only link between the RealDOM and the VirtualDOM.

Fields§

§subtree: usize

The ID of the subtree that these edits are targetting

§dirty_scopes: FxHashSet<ScopeId>

The list of Scopes that were diffed, created, and removed during the Diff process.

§templates: Vec<Template<'a>>

Any templates encountered while diffing the DOM.

These must be loaded into a cache before applying the edits

§edits: Vec<Mutation<'a>>

Any mutations required to patch the renderer to match the layout of the VirtualDom

Implementations§

source§

impl<'a> Mutations<'a>

source

pub fn santize(self) -> Self

Rewrites IDs to just be “template”, so you can compare the mutations

Used really only for testing

Trait Implementations§

source§

impl<'a> Debug for Mutations<'a>

source§

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

Formats the value using the given formatter. Read more
source§

impl<'a> Default for Mutations<'a>

source§

fn default() -> Mutations<'a>

Returns the “default value” for a type. Read more
source§

impl<'a> Serialize for Mutations<'a>

source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>where __S: Serializer,

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl<'a> !RefUnwindSafe for Mutations<'a>

§

impl<'a> !Send for Mutations<'a>

§

impl<'a> !Sync for Mutations<'a>

§

impl<'a> Unpin for Mutations<'a>

§

impl<'a> !UnwindSafe for Mutations<'a>

Blanket Implementations§

source§

impl<T> Any for Twhere T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for Twhere T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for Twhere T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for Twhere U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T, U> TryFrom<U> for Twhere U: Into<T>,

§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for Twhere U: TryFrom<T>,

§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more