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
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87

//! Submodule defining the trait for structs constructing edges in Mermaid
//! diagrams.

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

use crate::shared::{ArrowShape, LineStyle};

/// Trait representing an edge builder in a Mermaid diagram.
pub trait EdgeBuilder: Sized {
    /// The type of edge this builder constructs.
    type Edge;
    /// Type of the node this edge connects to.
    type Node;

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

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

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

    /// Set the source node for this edge.
    ///
    /// # Arguments
    ///
    /// * `node` - The source node for this edge.
    ///
    /// # Errors
    ///
    /// * If the node is not compatible with any of the other set parameters.
    fn source(self, node: Rc<Self::Node>) -> Result<Self, Self::Error>;

    /// Set the destination node for this edge.
    ///
    /// # Arguments
    ///
    /// * `node` - The destination node for this edge.
    ///
    /// # Errors
    ///
    /// * If the node is not compatible with any of the other set parameters.
    fn destination(self, node: Rc<Self::Node>) -> Result<Self, Self::Error>;

    #[must_use]
    /// Set the style class for this edge.
    ///
    /// # Arguments
    ///
    /// * `class` - The style class to set for this edge.
    fn line_style(self, style: LineStyle) -> Self;

    /// Set the left arrow shape for this edge.
    ///
    /// # Arguments
    ///
    /// * `shape` - The shape of the left arrow.
    ///
    /// # Errors
    ///
    /// * If the shape is not compatible with the associated node type.
    fn left_arrow_shape(self, shape: ArrowShape) -> Result<Self, Self::Error>;

    /// Set the right arrow shape for this edge.
    ///
    /// # Arguments
    ///
    /// * `shape` - The shape of the right arrow.
    ///
    /// # Errors
    ///
    /// * If the shape is not compatible with the associated node type.
    fn right_arrow_shape(self, shape: ArrowShape) -> Result<Self, Self::Error>;
}