Enum mt_dom::patch::Patch

source · [−]
pub enum Patch<'a, NS, TAG, ATT, VAL> where
    NS: PartialEq + Clone + Debug,
    TAG: PartialEq + Clone + Debug,
    ATT: PartialEq + Clone + Debug,
    VAL: PartialEq + Clone + Debug,  {
    InsertNode {
        tag: Option<&'a TAG>,
        patch_path: TreePath,
        node: &'a Node<NS, TAG, ATT, VAL>,
    },
    AppendChildren {
        tag: &'a TAG,
        patch_path: TreePath,
        children: Vec<&'a Node<NS, TAG, ATT, VAL>>,
    },
    RemoveNode {
        tag: Option<&'a TAG>,
        patch_path: TreePath,
    },
    ReplaceNode {
        tag: Option<&'a TAG>,
        patch_path: TreePath,
        replacement: &'a Node<NS, TAG, ATT, VAL>,
    },
    AddAttributes {
        tag: &'a TAG,
        patch_path: TreePath,
        attrs: Vec<&'a Attribute<NS, ATT, VAL>>,
    },
    RemoveAttributes {
        tag: &'a TAG,
        patch_path: TreePath,
        attrs: Vec<&'a Attribute<NS, ATT, VAL>>,
    },
    ChangeText {
        patch_path: TreePath,
        old: &'a Text,
        new: &'a Text,
    },
    ChangeComment {
        patch_path: TreePath,
        old: &'a String,
        new: &'a String,
    },
}
Expand description

A Patch encodes an operation that modifies a real DOM element or native UI element

To update the real DOM that a user sees you’ll want to first diff your old virtual dom and new virtual dom.

This diff operation will generate Vec<Patch> with zero or more patches that, when applied to your real DOM, will make your real DOM look like your new virtual dom.

Each of the Patch contains TreePath which contains an array of indexes for each node that we need to traverse to get the target element.

Consider the following html:

<body>
    <main>
        <input type="text"/>
        <img src="pic.jpg"/>
    </main>
    <footer>
        <a>Link</a>
        <nav/>
    </footer>
</body>

The corresponding DOM tree would be

             .─.
            ( 0 )  <body>
             `-'
            /   \
           /     \
          /       \
         ▼         ▼
 <main> .─.         .─. <footer>
       ( 0 )       ( 1 )
        `-'         `-'
       /  \          | \ '.
      /    \         |  \  '.
     ▼      ▼        |   \   '.
   .─.      .─.      ▼    ▼     ▼
  ( 0 )    ( 1 )    .─.   .─.   .─.
   `─'      `─'    ( 0 ) ( 1 ) ( 2 )
 <input> <img>      `─'   `─'   `─'
                   <a>  <Text>   <nav>

To traverse to the <nav> element we follow the TreePath([0,1,2]). 0 - is the root element which is always zero. 1 - is the footer element since it is the 2nd element of the body. 2 - is the nav element since it is the 3rd node in the footer element.

Variants

InsertNode

Fields

tag: Option<&'a TAG>

the tag of the target node we insert this node into

patch_path: TreePath

the path to traverse to get to the target element of which our node will be inserted before it.

node: &'a Node<NS, TAG, ATT, VAL>

the node to be inserted

Insert a vector of child nodes to the current node being patch. The usize is the index of of the children of the node to be patch to insert to. The new children will be inserted before this usize

AppendChildren

Fields

tag: &'a TAG

the tag of the node we are appending the children into

patch_path: TreePath

index of the node we are going to append the children into

children: Vec<&'a Node<NS, TAG, ATT, VAL>>

children nodes to be appended and their corresponding new_node_idx

Append a vector of child nodes to a parent node id.

RemoveNode

Fields

tag: Option<&'a TAG>

The tag of the node that is to be removed. This is only used for additional check where are removing the correct node.

patch_path: TreePath

the node_idx of the node to be removed

remove node

ReplaceNode

Fields

tag: Option<&'a TAG>

The tag of the node we are going to replace. This is only used for additional checking that we are removing the correct node.

patch_path: TreePath

the traversal path of the node we are going to replace

replacement: &'a Node<NS, TAG, ATT, VAL>

the node that will replace the target node

ReplaceNode a node with another node. This typically happens when a node’s tag changes. ex:

becomes

AddAttributes

Fields

tag: &'a TAG

node tag use for verifying that the we are patching the correct node which should match the same tag

patch_path: TreePath

the path to traverse to get to the target lement of which we add the attributes.

attrs: Vec<&'a Attribute<NS, ATT, VAL>>

the attributes to be patched into the target node

Add attributes that the new node has that the old node does not Note: the attributes is not a reference since attributes of same name are merged to produce a new unify attribute

RemoveAttributes

Fields

tag: &'a TAG

The tag of the node we are removing the attributes from. This is only used for additional check that we are patching the correct node

patch_path: TreePath

the path to traverse to get to the target lement of which we remove the attributes

attrs: Vec<&'a Attribute<NS, ATT, VAL>>

attributes that are to be removed from this target node

Remove attributes that the old node had that the new node doesn’t

ChangeText

Fields

patch_path: TreePath

the target element to be patch can be traverse using this patch path

old: &'a Text

the old text is not really needed for applying the patch. but it is useful for debugging purposed, that we are changing the intended target text by visual inspection

new: &'a Text

the neew text patch

Change the text of a Text node.

ChangeComment

Fields

patch_path: TreePath

the target element to be patch can be traverse using this patch path

old: &'a String

old comment

new: &'a String

new comment

Change comment content of a Comment node

Implementations

return the path to traverse for this patch to get to the target Node

return the tag of this patch

create an InsertNode patch

create a patch where we add children to the target node

create a patch where the target element that can be traverse using the patch path will be remove

create a patch where a node is replaced by the replacement node. The target node to be replace is traverse using the patch_path

create a patch where a new attribute is added to the target element

create patch where it remove attributes of the target element that can be traversed by the patch_path.

source

pub fn change_text(
    patch_path: TreePath,
    old: &'a Text,
    new: &'a Text
) -> Patch<'a, NS, TAG, ATT, VAL>

create a patch where the text content of a text node is changed

A patch where the comment node is changed

Trait Implementations

Returns a copy of the value. Read more

Performs copy-assignment from source. Read more

Formats the value using the given formatter. Read more

This method tests for self and other values to be equal, and is used by ==. Read more

This method tests for !=.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

Performs the conversion.

The resulting type after obtaining ownership.

Creates owned data from borrowed data, usually by cloning. Read more

🔬 This is a nightly-only experimental API. (toowned_clone_into)

Uses borrowed data to replace owned data, usually by cloning. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.