erd_rs 0.1.0

A command line utility that take Rust code as the source of truth to produce a entity relation diagram markdown file (e.g., mermaid.js file).
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

#[derive(Clone, Copy, Default)]
pub enum Vis {
    Public,
    Internal,
    Protected,
    #[default]
    Private,
}

impl From<Visibility> for Vis {
    fn from(value: Visibility) -> Self {
        match value {
            Visibility::Restricted(res) => {
                if res.path.is_ident("self") {
                    Vis::Private
                } else {
                    Vis::Internal
                }
            }
            Visibility::Inherited => Vis::Private,
            _ => Vis::Public,
        }
    }
}

pub trait ClassDiagramFormater {
    fn format_class(&self, name: String) -> String;

    fn format_field(&self, vis: String, name: String, ty: String) -> String;

    fn format_link(
        &self,
        clazz1: String,
        cardinality1: String,
        clazz2: String,
        cardinality2: String,
        label: String,
    ) -> String;

    fn format_class_end(&self) -> String;

    fn format_fn(
        &self,
        clazz: String,
        vis: String,
        method_name: String,
        inputs: Vec<(String, String)>,
        output: String,
    ) -> String;

    fn format_vis(&self, vis: Vis) -> String;
}

pub mod mmd_formater;
pub use mmd_formater::MMDFormater;
use syn::Visibility;