Struct Node 

pub struct Node {
    pub id: String,
    pub label: String,
    pub shape: Shape,
}

One node: a state, a step, a store. id is unique within the diagram and is what an Edge names; label is what a reader sees. The two are separate because a label is prose that may hold spaces, punctuation and a line break, and an id is a token a renderer writes into its own syntax:

use majordomus_cli::diagram::{Diagram, Kind, Node, Provenance};
let node = Node::new("handed_over", "handed over to the next session");
let drawn = Diagram::new("x", "X", Kind::Flow, Provenance::new("a", "b")).with_node(node);
assert!(drawn.to_mermaid().contains(r#"handed_over["handed over to the next session"]"#));
assert!(drawn.validate().is_empty(), "the id is a token even though the label is not");

Fields

id: String

Unique within the diagram, and safe to write into Mermaid source unquoted.

label: String

The short text drawn inside the node.

shape: Shape

What it is drawn as.

Implementations

impl Node

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

A box with this id and label — the node most derivations want.

use majordomus_cli::diagram::{Node, Shape};
let node = Node::new("active", "active");
assert_eq!(node.shape, Shape::Box);
assert_eq!(node.id, "active");

pub fn shaped(self, shape: Shape) -> Node

The same node with a different Shape — which is a statement about the thing and not about the picture: a derivation says a node is a store or a terminal, and every renderer then decides for itself how to draw that.

use majordomus_cli::diagram::{Node, Shape};
let node = Node::new("entry", "entry").shaped(Shape::Terminal);
assert_eq!(node.shape, Shape::Terminal);

Trait Implementations

impl Clone for Node

fn clone(&self) -> Node

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Node

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Node

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Node

impl JsonSchema for Node

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 Node

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

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

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

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 Node