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

//! TOML serialization support for Tree.

use crate::tree::Tree;

impl Tree {
    /// Deserializes a tree from TOML using serde.
    ///
    /// Requires the `serde-toml` feature.
    ///
    /// This method uses serde for deserialization, preserving the exact Tree structure.
    /// For visualizing arbitrary TOML files as trees, use `Tree::from_toml()` in the `toml` module.
    ///
    /// # 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 toml = original.to_toml().unwrap();
    ///
    /// // Deserialize it back
    /// let tree = Tree::from_toml(&toml).unwrap();
    /// assert_eq!(original, tree);
    /// ```
    pub fn from_toml(toml_str: &str) -> Result<Self, toml::de::Error> {
        toml::from_str(toml_str)
    }

    /// Serializes the tree to TOML using serde.
    ///
    /// Requires the `serde-toml` feature.
    ///
    /// This method uses serde for serialization, preserving the exact Tree structure.
    ///
    /// # Examples
    ///
    /// ```
    /// use treelog::Tree;
    ///
    /// let tree = Tree::Node("root".to_string(), vec![Tree::Leaf(vec!["item".to_string()])]);
    /// let toml = tree.to_toml().unwrap();
    /// ```
    pub fn to_toml(&self) -> Result<String, toml::ser::Error> {
        toml::to_string(self)
    }

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

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

    #[test]
    fn test_toml_roundtrip() {
        let tree = Tree::Node(
            "root".to_string(),
            vec![Tree::Leaf(vec!["item".to_string()])],
        );
        let toml = tree.to_toml().unwrap();
        let deserialized = Tree::from_toml(&toml).unwrap();
        assert_eq!(tree, deserialized);
    }
}