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
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70

//! Submodule defining the traits for building a node in Mermaid diagrams.

use alloc::{
    rc::Rc,
    string::{String, ToString},
};

use crate::shared::{StyleClass, StyleClassError, StyleProperty};

/// Trait for building nodes in Mermaid diagrams.
pub trait NodeBuilder: Sized {
    /// Type of the node that this builder constructs.
    type Node;

    /// The error type returned when building the node fails.
    type Error;

    /// Builds the node.
    ///
    /// # Errors
    ///
    /// Returns an error if the node cannot be built.
    fn build(self) -> Result<Self::Node, Self::Error>;

    /// Adds the provided style class to the node being built.
    ///
    /// # Arguments
    ///
    /// * `style_class` - The style class to add to the node.
    ///
    /// # Errors
    ///
    /// * If the style class name clashes with a previously applied class.
    fn style_class(self, style_class: Rc<StyleClass>) -> Result<Self, StyleClassError>;

    /// Adds a style property to the node being built.
    ///
    /// # Arguments
    ///
    /// * `property` - The style property to add to the node.
    ///
    /// # Errors
    ///
    /// * If the style property has already been set for the node.
    fn style_property(self, property: StyleProperty) -> Result<Self, StyleClassError>;

    /// Iterates across the style properties of the node being built.
    fn style_properties(&self) -> impl Iterator<Item = &StyleProperty>;

    /// Sets the label for the node being built.
    ///
    /// # Arguments
    ///
    /// * `label` - The label to set for the node.
    ///
    /// # Errors
    ///
    /// * If the label is empty.
    fn label<S: ToString>(self, label: S) -> Result<Self, Self::Error>;

    /// Returns a reference to the label of the node being built, if set.
    fn get_label(&self) -> Option<&String>;

    #[must_use]
    /// Sets the ID for the node being built.
    fn id(self, id: u64) -> Self;

    /// Returns the ID of the node being built, if set.
    fn get_id(&self) -> Option<u64>;
}