vizz 0.2.0

Tool for creating GraphViz/DOT visualizations of Rust data 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

//! Example of manually implementing Visualize for an enum

use std::fs::File;

use vizz::DataDescription;
use vizz::Graph;
use vizz::Value;
use vizz::Visualize;

enum MyEnum {
    Plain,
    WithU8(u8),
    WithU8AndString(u8, String),
    WithStruct { my_u8: u8, my_string: String },
}

impl Visualize for MyEnum {
    fn data(&self) -> Option<Value> {
        Some(Value::Owned(
            match self {
                MyEnum::Plain => "Plain",
                MyEnum::WithU8(_) => "WithU8",
                MyEnum::WithU8AndString(_, _) => "WithU8AndString",
                MyEnum::WithStruct { .. } => "WithStruct",
            }
            .into(),
        ))
    }

    fn associated_data(&self) -> Option<Vec<DataDescription>> {
        match self {
            MyEnum::Plain => None,
            MyEnum::WithU8(a) => Some(vec![DataDescription::from(a)]),
            MyEnum::WithU8AndString(a, b) => {
                Some(vec![DataDescription::from(a), DataDescription::from(b)])
            }
            MyEnum::WithStruct { my_u8, my_string } => Some(vec![
                DataDescription::from(my_u8).with_label("my_u8"),
                DataDescription::from(my_string).with_label("my_string"),
            ]),
        }
    }
}

pub fn main() -> Result<(), Box<dyn std::error::Error>> {
    // create some values
    let plain_enum = MyEnum::Plain;
    let enum_with_u8_and_string = MyEnum::WithU8AndString(8, String::from("hey"));
    let enum_with_u8 = MyEnum::WithU8(8);
    let enum_with_named_fields = MyEnum::WithStruct {
        my_u8: 8,
        my_string: String::from("hey"),
    };

    // create file
    let mut dot_file = File::create("my_enum.dot")?;

    // create graph
    Graph::new()
        .set_id("my_enum_visualization")
        .add_node(&plain_enum)
        .add_node(&enum_with_named_fields)
        .add_node(&enum_with_u8)
        .add_node(&enum_with_u8_and_string)
        .write_to(&mut dot_file)?;

    Ok(())
}