ptree 0.5.2

Pretty-print tree-like structures
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

use crate::item::TreeItem;
use crate::output::{print_tree, write_tree_with};
use crate::print_config::PrintConfig;
use crate::style::Style;

use std::borrow::Cow;
use std::fmt::Display;
use std::io;

use petgraph::graph::IndexType;
use petgraph::prelude::*;
use petgraph::EdgeType;

impl<'a, N, E, Ty, Ix> TreeItem for (&'a Graph<N, E, Ty, Ix>, NodeIndex<Ix>)
where
    Ty: EdgeType,
    Ix: IndexType,
    N: Clone + Display,
    E: Clone,
{
    type Child = Self;

    fn write_self<W: io::Write>(&self, f: &mut W, style: &Style) -> io::Result<()> {
        if let Some(w) = self.0.node_weight(self.1) {
            write!(f, "{}", style.paint(w))
        } else {
            Ok(())
        }
    }

    fn children(&self) -> Cow<[Self::Child]> {
        let v: Vec<_> = self.0.neighbors(self.1).map(|i| (self.0, i)).collect();
        Cow::from(v)
    }
}

///
/// Print `graph`, starting at node `start`, to standard output using default
/// formatting
pub fn print_graph<N, E, Ty, Ix>(graph: &Graph<N, E, Ty, Ix>, start: NodeIndex<Ix>) -> io::Result<()>
where
    Ty: EdgeType,
    Ix: IndexType,
    N: Clone + Display,
    E: Clone,
{
    print_tree(&(graph, start))
}

///
/// Write `graph`, starting at node `start`, to writer `f` using custom
/// formatting
pub fn write_graph_with<N, E, Ty, Ix, W: io::Write>(
    graph: &Graph<N, E, Ty, Ix>,
    start: NodeIndex<Ix>,
    f: W,
    config: &PrintConfig,
) -> io::Result<()>
where
    Ty: EdgeType,
    Ix: IndexType,
    N: Clone + Display,
    E: Clone,
{
    write_tree_with(&(graph, start), f, config)
}

#[cfg(test)]
mod tests {
    use super::*;
    use std::io::Cursor;
    use std::str::from_utf8;

    #[test]
    fn small_graph_output() {
        let mut deps = Graph::<&str, &str>::new();
        let pg = deps.add_node("petgraph");
        let fb = deps.add_node("fixedbitset");
        let qc = deps.add_node("quickcheck");
        let rand = deps.add_node("rand");
        let libc = deps.add_node("libc");
        deps.extend_with_edges(&[(pg, fb), (pg, qc), (qc, rand), (rand, libc), (qc, libc)]);

        let config = PrintConfig {
            indent: 4,
            leaf: Style::default(),
            branch: Style::default(),
            ..PrintConfig::default()
        };

        let mut cursor: Cursor<Vec<u8>> = Cursor::new(Vec::new());

        write_graph_with(&deps, pg, &mut cursor, &config).unwrap();

        let data = cursor.into_inner();
        let expected = "\
                        petgraph\n\
                        ├── quickcheck\n\
                        │   ├── libc\n\
                        │   └── rand\n\
                        │       └── libc\n\
                        └── fixedbitset\n\
                        ";
        assert_eq!(from_utf8(&data).unwrap(), expected);
    }
}