dltree 0.1.5

Doubly linked tree with leaf-considering typing
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188

use crate::internal::tree_element_impl::TreeElementImpl;
use crate::tree_elements::tree_element::TreeElement;

#[derive(Debug)]
pub enum DLTreeError {
    // This error should never happen and is a bug in dltree
    // Please report any occurence of this error
    IntegrityViolated,
    // This error happens if child manipulations like insertions or replacements are applied on the root element
    ChildOperationOnRootLevel,
}

pub enum Value<IT, LT> {
    Node(IT),
    Leaf(LT),
}

pub struct Tree<IT, LT> {
    pub(crate) tree: TreeElementImpl<IT, LT>,
}

impl<IT, LT> Tree<IT, LT> {
    pub fn new(root_value: Value<IT, LT>) -> Self {
        Tree {
            tree: TreeElementImpl::new(root_value, None),
        }
    }
    pub fn root_node(&self) -> TreeElement<IT, LT> {
        TreeElement::new(&self.tree)
    }
}

#[cfg(test)]
mod tests {
    use crate::tree::{DLTreeError, Tree, Value};
    use std::borrow::BorrowMut;

    #[test]
    fn tree_building_test() {
        let tree = Tree::new(Value::Node(23));
        assert!(tree.root_node().as_leaf().is_none());
        let mut node = tree.root_node().as_node().unwrap();
        assert_eq!(*node.value(), 23);

        let pushed_element = node.push_child(Value::Leaf(34));
        assert!(pushed_element.as_node().is_none());

        let leaf = pushed_element.as_leaf().unwrap();
        assert_eq!(*leaf.value(), 34);
        assert_eq!(node.children().len(), 1);
    }

    #[test]
    fn value_set_test() {
        let node = Tree::<i32, i32>::new(Value::Node(34));
        *node.root_node().borrow_mut().value_mut() = 33;
        assert_eq!(*node.root_node().borrow_mut().value(), 33);

        let leaf = Tree::<i32, i32>::new(Value::Leaf(45));
        *leaf.root_node().borrow_mut().value_mut() = 44;
        assert_eq!(*leaf.root_node().borrow_mut().value(), 44);
    }

    #[test]
    fn element_rempval_test() -> Result<(), DLTreeError> {
        let tree = Tree::new(Value::Node(11));
        let mut node11 = tree.root_node().as_node().unwrap();
        let mut node21 = node11.push_child(Value::Node(21)).as_node().unwrap();
        assert_eq!(node11, node21.parent()?.unwrap());
        let mut _node31 = node21.push_child(Value::Node(31)).as_node().unwrap();
        let mut node32 = node21.push_child(Value::Node(32)).as_node().unwrap();
        let mut _node33 = node21.push_child(Value::Node(33)).as_node().unwrap();
        let mut leaf34 = node21.push_child(Value::Leaf(34)).as_leaf().unwrap();
        let mut leaf_41 = node32.push_child(Value::Leaf(41)).as_leaf().unwrap();
        assert_eq!(leaf_41.parent()?.unwrap(), node32);

        let removed_node_32 = node32.remove_from_tree()?;
        {
            let n = removed_node_32.root_node().as_node().unwrap();
            assert_eq!(*n.value(), 32);
            assert_eq!(n.children().len(), 1);
            assert!(n.parent()?.is_none());
        }

        let _removed_leaf_34 = leaf34.remove_from_tree()?;

        assert_eq!(node21.children().len(), 2);
        assert_eq!(*node21.children().get(0).unwrap().value(), 31);
        assert_eq!(*node21.children().get(1).unwrap().value(), 33);

        {
            let l = leaf_41.remove_from_tree()?.root_node().as_leaf().unwrap();
            assert_eq!(*l.value(), 41);
            assert!(l.parent()?.is_none());
        }
        {
            let n = removed_node_32.root_node().as_node().unwrap();
            assert_eq!(n.children().len(), 0);
        }
        Ok(())
    }

    #[test]
    fn tree_element_test() -> Result<(), DLTreeError> {
        let tree = Tree::new(Value::Node(23));
        assert!(tree.root_node().parent()?.is_none());
        let mut node = tree.root_node().as_node().unwrap();
        let mut sub_tree = node.push_child(Value::Node(34));
        assert!(sub_tree.parent()?.is_some());
        let mut sub_sub_tree = sub_tree.as_node().unwrap().push_child(Value::Leaf(45));
        assert!(sub_sub_tree.parent()?.is_some());
        assert_eq!(sub_tree.as_node().unwrap().children().len(), 1);
        let removed_sub_sub_tree = sub_sub_tree.remove_from_tree()?;
        assert!(removed_sub_sub_tree.root_node().remove_from_tree().is_err());
        assert_eq!(sub_tree.as_node().unwrap().children().len(), 0);
        assert_eq!(tree.root_node().as_node().unwrap().children().len(), 1);
        let removed_sub_tree = sub_tree.remove_from_tree()?;
        assert!(removed_sub_tree.root_node().remove_from_tree().is_err());
        assert_eq!(tree.root_node().as_node().unwrap().children().len(), 0);
        Ok(())
    }

    #[test]
    fn replace_test() -> Result<(), DLTreeError> {
        let tree = Tree::<i32, i32>::new(Value::Node(34));
        let leaf = tree
            .root_node()
            .as_node()
            .unwrap()
            .push_child(Value::Leaf(45));
        let mut node = leaf
            .as_leaf()
            .unwrap()
            .set(Value::Node(56))?
            .as_node()
            .unwrap();
        node.push_child(Value::Leaf(67));
        let sub_leaf = node.set(Value::Leaf(78))?.as_leaf().unwrap();
        assert_eq!(*sub_leaf.parent()?.unwrap().value(), 34);
        Ok(())
    }
    #[test]
    fn insert_test() -> Result<(), DLTreeError> {
        let tree = Tree::<i32, i32>::new(Value::Node(11));
        tree.root_node()
            .as_node()
            .unwrap()
            .push_child(Value::Leaf(21));
        let middle_leaf = tree
            .root_node()
            .as_node()
            .unwrap()
            .push_child(Value::Leaf(22));
        tree.root_node()
            .as_node()
            .unwrap()
            .push_child(Value::Leaf(23));
        assert_eq!(
            tree.root_node()
                .as_node()
                .unwrap()
                .children()
                .iter()
                .map(|c| *c.value())
                .collect::<Vec<i32>>(),
            vec![21, 22, 23]
        );
        middle_leaf
            .as_leaf()
            .unwrap()
            .insert_before(Value::Leaf(44))?;
        middle_leaf
            .as_leaf()
            .unwrap()
            .insert_after(Value::Node(45))?;
        assert_eq!(
            tree.root_node()
                .as_node()
                .unwrap()
                .children()
                .iter()
                .map(|c| *c.value())
                .collect::<Vec<i32>>(),
            vec![21, 44, 22, 45, 23]
        );
        Ok(())
    }
}