Struct Subgraph 

pub struct Subgraph {
    pub id: String,
    pub label: String,
    pub direction: Option<Direction>,
    pub node_ids: Vec<String>,
    pub subgraph_ids: Vec<String>,
}

A named cluster of nodes (and optionally nested subgraphs).

Subgraphs are rendered as a rounded rectangle that encloses all their direct and indirect member nodes. Edges may freely cross subgraph boundaries.

Fields

id: String

Unique identifier (the id token after subgraph).

label: String

Human-readable label displayed at the top of the border. Falls back to id when not explicitly specified.

direction: Option<Direction>

Optional per-subgraph flow direction override.

Currently preserved on the model for future use; the renderer always uses the parent graph direction.

node_ids: Vec<String>

IDs of direct child nodes (not recursively nested ones).

subgraph_ids: Vec<String>

IDs of direct child subgraphs.

Implementations

impl Subgraph

pub fn new(id: impl Into<String>, label: impl Into<String>) -> Self

Construct a new subgraph with the given id and label.

Both node_ids and subgraph_ids start empty; the parser fills them as it processes the subgraph body. direction defaults to None (inherits from the parent graph).

Arguments

• id — unique identifier (the token after subgraph)
• label — display label at the top of the border

Examples

use mermaid_text::types::Subgraph;

let sg = Subgraph::new("S1", "My Cluster");
assert_eq!(sg.id, "S1");
assert_eq!(sg.label, "My Cluster");
assert!(sg.node_ids.is_empty());
assert!(sg.direction.is_none());

Trait Implementations

impl Clone for Subgraph

fn clone(&self) -> Subgraph

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Subgraph

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

Formats the value using the given formatter.

impl PartialEq for Subgraph

fn eq(&self, other: &Subgraph) -> 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 Subgraph

impl StructuralPartialEq for Subgraph