Struct Edge 

pub struct Edge {
    pub from: String,
    pub to: String,
    pub label: Option<String>,
    pub style: EdgeStyle,
    pub end: EdgeEndpoint,
    pub start: EdgeEndpoint,
}

A directed connection between two nodes.

Fields

from: String

ID of the source node.

to: String

ID of the destination node.

label: Option<String>

Optional label placed along the edge.

style: EdgeStyle

Visual style of the edge line (solid, dotted, or thick).

end: EdgeEndpoint

Endpoint drawn at the destination end.

start: EdgeEndpoint

Endpoint drawn at the source end (for bidirectional edges).

Implementations

impl Edge

pub fn new( from: impl Into<String>, to: impl Into<String>, label: Option<String>, ) -> Self

Construct a new solid arrow edge (the most common case).

Equivalent to new_styled with EdgeStyle::Solid, EdgeEndpoint::None at the source, and EdgeEndpoint::Arrow at the destination.

Arguments

• from — source node ID
• to — destination node ID
• label — optional label placed along the edge

Examples

use mermaid_text::{Edge, EdgeEndpoint, EdgeStyle};

let e = Edge::new("A", "B", Some("ok".to_string()));
assert_eq!(e.from, "A");
assert_eq!(e.to, "B");
assert_eq!(e.label.as_deref(), Some("ok"));
assert_eq!(e.style, EdgeStyle::Solid);
assert_eq!(e.end, EdgeEndpoint::Arrow);
assert_eq!(e.start, EdgeEndpoint::None);

pub fn new_styled( from: impl Into<String>, to: impl Into<String>, label: Option<String>, style: EdgeStyle, start: EdgeEndpoint, end: EdgeEndpoint, ) -> Self

Construct an edge with explicit style and endpoint kinds.

Arguments

• from — source node ID
• to — destination node ID
• label — optional label placed along the edge
• style — line style (solid, dotted, thick)
• start — endpoint at the source end
• end — endpoint at the destination end

Examples

use mermaid_text::{Edge, EdgeEndpoint, EdgeStyle};

// A bidirectional thick edge with a label
let e = Edge::new_styled(
    "A", "B",
    Some("sync".to_string()),
    EdgeStyle::Thick,
    EdgeEndpoint::Arrow,
    EdgeEndpoint::Arrow,
);
assert_eq!(e.style, EdgeStyle::Thick);
assert_eq!(e.start, EdgeEndpoint::Arrow);
assert_eq!(e.end, EdgeEndpoint::Arrow);

Trait Implementations

impl Clone for Edge

fn clone(&self) -> Edge

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Edge

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl PartialEq for Edge

fn eq(&self, other: &Edge) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Edge

impl StructuralPartialEq for Edge