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

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

use alloc::rc::Rc;

use crate::{
    shared::{ArrowShape, LineStyle},
    traits::{EdgeBuilder, Node},
};

/// Trait representing an edge in a Mermaid diagram.
pub trait Edge: Ord {
    /// Type of the builder used to construct this edge.
    type Builder: EdgeBuilder<Edge = Self>;
    /// Type of the node this edge connects to.
    type Node: Node;

    /// Returns a reference to the label of the edge.
    fn label(&self) -> Option<&str>;

    /// Returns a reference to the source node of the edge.
    fn source(&self) -> &Rc<Self::Node>;

    /// Returns a reference to the destination node of the edge.
    fn destination(&self) -> &Rc<Self::Node>;

    /// Returns the line style of the edge.
    fn line_style(&self) -> LineStyle;

    /// Returns an iterator over the style classes associated with the edge.
    fn classes(&self) -> impl Iterator<Item = &crate::shared::StyleClass>;

    /// Returns the left arrow shape of the edge, if any.
    fn left_arrow_shape(&self) -> Option<ArrowShape>;

    /// Returns the right arrow shape of the edge, if any.
    fn right_arrow_shape(&self) -> Option<ArrowShape>;
}