treelog 0.0.6

A highly customizable, optimized, and modular tree rendering library
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

//! RON (Rusty Object Notation) serialization support for Tree.

use crate::tree::Tree;

impl Tree {
    /// Deserializes a tree from RON.
    ///
    /// Requires the `serde-ron` feature.
    ///
    /// # Examples
    ///
    /// ```
    /// use treelog::Tree;
    ///
    /// // Create a tree and serialize it
    /// let original = Tree::Node("root".to_string(), vec![Tree::Leaf(vec!["item".to_string()])]);
    /// let ron = original.to_ron().unwrap();
    ///
    /// // Deserialize it back
    /// let tree = Tree::from_ron(&ron).unwrap();
    /// assert_eq!(original, tree);
    /// ```
    pub fn from_ron(ron_str: &str) -> Result<Self, ron::de::SpannedError> {
        ron::from_str(ron_str)
    }

    /// Serializes the tree to RON.
    ///
    /// Requires the `serde-ron` feature.
    ///
    /// # Examples
    ///
    /// ```
    /// use treelog::Tree;
    ///
    /// let tree = Tree::Node("root".to_string(), vec![Tree::Leaf(vec!["item".to_string()])]);
    /// let ron = tree.to_ron().unwrap();
    /// ```
    pub fn to_ron(&self) -> Result<String, ron::error::Error> {
        ron::to_string(self)
    }

    /// Serializes the tree to pretty-printed RON.
    ///
    /// Requires the `serde-ron` feature.
    ///
    /// # Examples
    ///
    /// ```
    /// use treelog::Tree;
    ///
    /// let tree = Tree::Node("root".to_string(), vec![Tree::Leaf(vec!["item".to_string()])]);
    /// let ron = tree.to_ron_pretty().unwrap();
    /// ```
    pub fn to_ron_pretty(&self) -> Result<String, ron::error::Error> {
        let pretty = ron::ser::PrettyConfig::default();
        ron::ser::to_string_pretty(self, pretty)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    #[test]
    fn test_ron_roundtrip() {
        let tree = Tree::Node(
            "root".to_string(),
            vec![
                Tree::Leaf(vec!["item1".to_string()]),
                Tree::Node(
                    "sub".to_string(),
                    vec![Tree::Leaf(vec!["subitem".to_string()])],
                ),
            ],
        );
        let ron = tree.to_ron().unwrap();
        let deserialized = Tree::from_ron(&ron).unwrap();
        assert_eq!(tree, deserialized);
    }

    #[test]
    fn test_ron_pretty() {
        let tree = Tree::Node(
            "root".to_string(),
            vec![Tree::Leaf(vec!["item".to_string()])],
        );
        let ron = tree.to_ron_pretty().unwrap();
        assert!(!ron.is_empty());
    }
}