Struct Group 

pub struct Group {
    pub id: String,
    pub label: String,
    pub members: Vec<String>,
}

A box drawn around several nodes: Mermaid’s subgraph. A flowchart concept — a state machine has composite states instead, which this model does not carry, and Diagram::validate says so rather than dropping the group in silence.

use majordomus_cli::diagram::{Diagram, Group, Kind, Node, Provenance};
let drawn = Diagram::new("x", "X", Kind::Flow, Provenance::new("a", "b"))
    .with_node(Node::new("a", "A"))
    .with_node(Node::new("loose", "Loose"))
    .with_group(Group::new("canonical", "canonical", ["a"]));
let mermaid = drawn.to_mermaid();
assert!(mermaid.contains("    subgraph canonical [\"canonical\"]\n        a[\"A\"]\n    end"));
assert!(mermaid.contains("\n    loose[\"Loose\"]"), "an ungrouped node stays outside");

Fields

id: String

Unique within the diagram, and distinct from every node id.

label: String

The text drawn on the box.

members: Vec<String>

The ids of the nodes inside it, in the order they should be drawn.

Implementations

impl Group

pub fn new( id: impl Into<String>, label: impl Into<String>, members: impl IntoIterator<Item = impl Into<String>>, ) -> Group

A group over the node ids given, in that order.

use majordomus_cli::diagram::Group;
let group = Group::new("canonical", "canonical", ["a", "b"]);
assert_eq!(group.members, vec!["a".to_string(), "b".to_string()]);

Trait Implementations

impl Clone for Group

fn clone(&self) -> Group

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Group

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Group

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Group

impl JsonSchema for Group

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl Ord for Group

fn cmp(&self, other: &Group) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Group

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

fn partial_cmp(&self, other: &Group) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Serialize for Group

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Group