Enum dioxus_core::Mutation

source ·

pub enum Mutation<'a> {
Show 16 variants    AppendChildren {
        id: ElementId,
        m: usize,
    },
    AssignId {
        path: &'static [u8],
        id: ElementId,
    },
    CreatePlaceholder {
        id: ElementId,
    },
    CreateTextNode {
        value: &'a str,
        id: ElementId,
    },
    HydrateText {
        path: &'static [u8],
        value: &'a str,
        id: ElementId,
    },
    LoadTemplate {
        name: &'static str,
        index: usize,
        id: ElementId,
    },
    ReplaceWith {
        id: ElementId,
        m: usize,
    },
    ReplacePlaceholder {
        path: &'static [u8],
        m: usize,
    },
    InsertAfter {
        id: ElementId,
        m: usize,
    },
    InsertBefore {
        id: ElementId,
        m: usize,
    },
    SetAttribute {
        name: &'a str,
        value: BorrowedAttributeValue<'a>,
        id: ElementId,
        ns: Option<&'a str>,
    },
    SetText {
        value: &'a str,
        id: ElementId,
    },
    NewEventListener {
        name: &'a str,
        id: ElementId,
    },
    RemoveEventListener {
        name: &'a str,
        id: ElementId,
    },
    Remove {
        id: ElementId,
    },
    PushRoot {
        id: ElementId,
    },
}

Expand description

A Mutation represents a single instruction for the renderer to use to modify the UI tree to match the state of the Dioxus VirtualDom.

These edits can be serialized and sent over the network or through any interface

Variants§

§

AppendChildren

Fields

§id: ElementId

The ID of the element being mounted to

§m: usize

The number of nodes on the stack to append to the target element

Add these m children to the target element

§

AssignId

Fields

§path: &'static [u8]

The path of the child of the topmost node on the stack

A path of [] represents the topmost node. A path of [0] represents the first child. [0,1,2] represents 1st child’s 2nd child’s 3rd child.

§id: ElementId

The ID we’re assigning to this element/placeholder.

This will be used later to modify the element or replace it with another element.

Assign the element at the given path the target ElementId.

The path is in the form of a list of indices based on children. Templates cannot have more than 255 children per element, hence the use of a single byte.

§

CreatePlaceholder

Fields

§id: ElementId

The ID we’re assigning to this element/placeholder.

This will be used later to modify the element or replace it with another element.

Create an placeholder int he DOM that we will use later.

Dioxus currently requires the use of placeholders to maintain a re-entrance point for things like list diffing

§

CreateTextNode

Fields

§value: &'a str

The text content of this text node

§id: ElementId

The ID we’re assigning to this specific text nodes

This will be used later to modify the element or replace it with another element.

Create a node specifically for text with the given value

§

HydrateText

Fields

§path: &'static [u8]

The path of the child of the topmost node on the stack

A path of [] represents the topmost node. A path of [0] represents the first child. [0,1,2] represents 1st child’s 2nd child’s 3rd child.

§value: &'a str

The value of the textnode that we want to set the placeholder with

§id: ElementId

The ID we’re assigning to this specific text nodes

This will be used later to modify the element or replace it with another element.

Hydrate an existing text node at the given path with the given text.

Assign this text node the given ID since we will likely need to modify this text at a later point

§

LoadTemplate

Fields

§name: &'static str

The “name” of the template. When paired with rsx!, this is autogenerated

§index: usize

Which root are we loading from the template?

The template is stored as a list of nodes. This index represents the position of that root

§id: ElementId

The ID we’re assigning to this element being loaded from the template

This will be used later to move the element around in lists

Load and clone an existing node from a template saved under that specific name

Dioxus guarantees that the renderer will have already been provided the template. When the template is picked up in the template list, it should be saved under its “name” - here, the name

§