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

//! Submodule defining the `ConfigurationBuilder` trait for Mermaid diagrams.

use alloc::string::ToString;

use crate::shared::generic_configuration::{Direction, Renderer};

/// Trait defining a configuration builder for Mermaid diagrams.
pub trait ConfigurationBuilder: Sized {
    /// Type of the configuration that this builder constructs.
    type Configuration;

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

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

    /// Returns the current title of the configuration, if any.
    ///
    /// # Arguments
    ///
    /// * `title` - The title to set for the configuration.
    ///
    /// # Errors
    ///
    /// * If the provided title is empty.
    fn title<S: ToString>(self, title: S) -> Result<Self, Self::Error>;

    #[must_use]
    /// Sets the renderer to use for the diagram.
    fn renderer(self, renderer: Renderer) -> Self;

    #[must_use]
    /// Sets the direction of the flowchart.
    fn direction(self, direction: Direction) -> Self;
}