ariel-rs 0.2.0

A faithful Rust port of Mermaid JS — headless SVG diagram rendering without a browser
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
88
89
90
91
92
93
94
95
96

//! SVG template functions for the packet renderer.
//!
//! Each function takes typed parameters and returns a `String`.
//! No rendering logic lives here — only string formatting.

// ---------------------------------------------------------------------------
// Utilities
// ---------------------------------------------------------------------------

pub use crate::diagrams::util::{esc, fmt};

// ---------------------------------------------------------------------------
// CSS
// ---------------------------------------------------------------------------

pub fn build_style(id: &str, ff: &str) -> String {
    // Matches mermaid's packet styles (defaultPacketStyleOptions)
    format!(
        "#{id}{{font-family:{ff};font-size:16px;fill:#333;}}\
        #{id} .packetByte{{font-size:10px;}}\
        #{id} .packetByte.start{{fill:black;}}\
        #{id} .packetByte.end{{fill:black;}}\
        #{id} .packetLabel{{fill:black;font-size:12px;}}\
        #{id} .packetTitle{{fill:black;font-size:14px;}}\
        #{id} .packetBlock{{stroke:black;stroke-width:1;fill:#efefef;}}\
        #{id} :root{{--mermaid-font-family:{ff};}}",
        id = id,
        ff = ff,
    )
}

// ---------------------------------------------------------------------------
// Top-level SVG structure
// ---------------------------------------------------------------------------

/// Render the outer `<svg>` element for a packet diagram.
pub fn svg_root(svg_id: &str, w: &str, h: &str, max_w: &str) -> String {
    format!(
        "<svg id=\"{svg_id}\" width=\"100%\" xmlns=\"http://www.w3.org/2000/svg\" xmlns:xlink=\"http://www.w3.org/1999/xlink\" viewBox=\"0 0 {w} {h}\" style=\"max-width: {max_w}px;\" role=\"graphics-document document\" aria-roledescription=\"packet\" aria-labelledby=\"chart-title-{svg_id}\"><title id=\"chart-title-{svg_id}\">Packet</title>",
    )
}

/// Render an empty packet SVG placeholder.
pub fn empty_svg(svg_id: &str, ff: &str) -> String {
    format!(
        "<svg id=\"{svg_id}\" xmlns=\"http://www.w3.org/2000/svg\" viewBox=\"0 0 100 50\"><text x=\"10\" y=\"30\" font-family=\"{ff}\" font-size=\"14\">Empty packet diagram</text></svg>",
    )
}

// ---------------------------------------------------------------------------
// Field elements
// ---------------------------------------------------------------------------

/// Render a packet field background rectangle.
pub fn field_rect(x: &str, y: &str, w: &str, h: &str) -> String {
    format!("<rect x=\"{x}\" y=\"{y}\" width=\"{w}\" height=\"{h}\" class=\"packetBlock\"></rect>",)
}

/// Render a packet field label (centered in the box).
pub fn field_label(x: &str, y: &str, text: &str) -> String {
    format!(
        "<text x=\"{x}\" y=\"{y}\" class=\"packetLabel\" dominant-baseline=\"middle\" text-anchor=\"middle\">{text}</text>",
    )
}

/// Render a bit-number label for a single-bit field (centered, middle anchor).
pub fn bit_number_single(x: &str, y: &str, bit: u32) -> String {
    format!(
        "<text x=\"{x}\" y=\"{y}\" class=\"packetByte start\" dominant-baseline=\"auto\" text-anchor=\"middle\">{bit}</text>",
    )
}

/// Render the start bit-number label for a multi-bit field (left-aligned).
pub fn bit_number_start(x: &str, y: &str, bit: u32) -> String {
    format!(
        "<text x=\"{x}\" y=\"{y}\" class=\"packetByte start\" dominant-baseline=\"auto\" text-anchor=\"start\">{bit}</text>",
    )
}

/// Render the end bit-number label for a multi-bit field (right-aligned).
pub fn bit_number_end(x: &str, y: &str, bit: u32) -> String {
    format!(
        "<text x=\"{x}\" y=\"{y}\" class=\"packetByte end\" dominant-baseline=\"auto\" text-anchor=\"end\">{bit}</text>",
    )
}

// ---------------------------------------------------------------------------
// Title
// ---------------------------------------------------------------------------

/// Render the diagram title text element.
pub fn title(x: &str, y: &str, text: &str) -> String {
    format!(
        "<text x=\"{x}\" y=\"{y}\" dominant-baseline=\"middle\" text-anchor=\"middle\" class=\"packetTitle\">{text}</text>",
    )
}