mermaid-builder 0.1.2

A Rust library for generating Mermaid diagrams using the builder pattern.
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

//! Submodule defining a class attribute struct for the class diagram in
//! Mermaid syntax, including its visibility and type.

use alloc::string::String;
use core::fmt::{self, Display};

use crate::diagrams::class_diagram::visibility::Visibility;

#[derive(Clone, Debug, PartialEq, Eq, Hash, PartialOrd, Ord)]
#[cfg_attr(feature = "serde", derive(serde::Serialize, serde::Deserialize))]
/// Struct representing a class attribute in a class diagram.
pub struct ClassAttribute {
    /// The name of the class attribute.
    name: String,
    /// The type of the class attribute.
    attribute_type: String,
    /// The visibility of the class attribute (e.g., public, private).
    visibility: Visibility,
}

impl ClassAttribute {
    /// Creates a new class attribute.
    pub fn new(attribute_type: impl Into<String>, name: impl Into<String>) -> Self {
        Self {
            name: name.into(),
            attribute_type: attribute_type.into(),
            visibility: Visibility::Public,
        }
    }
}

impl Display for ClassAttribute {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        write!(f, "{} {}: {}", self.visibility, self.name, self.attribute_type)
    }
}

#[cfg(test)]
mod tests {
    use alloc::string::ToString;

    use super::*;

    #[test]
    fn test_class_attribute_display() {
        let attr = ClassAttribute {
            name: "attr1".to_string(),
            attribute_type: "int".to_string(),
            visibility: Visibility::Public,
        };
        assert_eq!(attr.to_string(), "+ attr1: int");
    }
}