Struct mt_dom::TreePath

pub struct TreePath {
    pub path: Vec<usize>,
}

Describe the path traversal of a Node starting from the root node

The figure below shows node_idx in a depth first traversal.

           .─.
          ( 0 )
           `-'
          /   \
         /     \
        /       \
       ▼         ▼
      .─.         .─.
     ( 1 )       ( 4 )
      `-'         `-'
     /  \          | \ '.
    /    \         |  \  '.
   ▼      ▼        |   \   '.
 .─.      .─.      ▼    ▼     ▼
( 2 )    ( 3 )    .─.   .─.   .─.
 `─'      `─'    ( 5 ) ( 6 ) ( 7 )
                  `─'   `─'   `─'

The figure below shows the index of each child node relative to their parent node

            .─.
           ( 0 )
            `-'
           /   \
          /     \
         /       \
        ▼         ▼
       .─.         .─.
      ( 0 )       ( 1 )
       `-'         `-'
      /  \          | \ '.
     /    \         |  \  '.
    ▼      ▼        |   \   '.
  .─.      .─.      ▼    ▼     ▼
 ( 0 )    ( 1 )    .─.   .─.   .─.
  `─'      `─'    ( 0 ) ( 1 ) ( 2 )
                   `─'   `─'   `─'

The equivalent idx and path are as follows:

   0 = [0]
   1 = [0,0]
   2 = [0,0,0]
   3 = [0,0,1]
   4 = [0,1]
   5 = [0,1,0]
   6 = [0,1,1]
   7 = [0,1,2]

Fields

path: Vec<usize>

an alternative path vector, where it specifies the first element is the index of the root node which is always 0 the second element is the index of the child to traverse to and so on. Given a DOM tree where node_idx and path was derived from, we can verify that node_idx and path point to the same node. The advantage of using this is that this doesn’t need to traverse nodes that are not relevant. Traversal operation complexity is O(log n)

Implementations

impl TreePath

pub fn new(path: Vec<usize>) -> Self

create a TreePath with node index node_idx and traversal path path

pub fn push(&mut self, node_idx: usize)

add a path node idx

pub fn remove_first(&mut self) -> usize

remove first node index of this treepath Everytime a node is traversed, the first element should be removed until no more index is in this path

pub fn is_empty(&self) -> bool

returns tree if the path is empty This is used for checking if the path has been traversed

pub fn find_node_by_path<'a, NS, TAG, LEAF, ATT, VAL>(
    &self,
    node: &'a Node<NS, TAG, LEAF, ATT, VAL>
) -> Option<&'a Node<NS, TAG, LEAF, ATT, VAL>> where
    NS: PartialEq + Clone + Debug,
    TAG: PartialEq + Clone + Debug,
    LEAF: PartialEq + Clone + Debug,
    ATT: PartialEq + Clone + Debug,
    VAL: PartialEq + Clone + Debug, 

find the node using the path of this tree path

Trait Implementations

impl Clone for TreePath

fn clone(&self) -> TreePath

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TreePath

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

Formats the value using the given formatter.

impl PartialEq<TreePath> for TreePath

fn eq(&self, other: &TreePath) -> bool

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

fn ne(&self, other: &TreePath) -> bool

This method tests for !=.

impl StructuralPartialEq for TreePath