Struct Edge 

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

One edge, from a node id to a node id, with the transition or the reason written on it.

An edge names ids and never nodes, so a derivation can state a relationship before it has built both ends — and Diagram::validate is what refuses an end that never arrived, rather than a renderer discovering it while writing broken syntax:

use majordomus_cli::diagram::{Diagram, Edge, 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("b", "B"))
    .with_edge(Edge::new("a", "b").labelled("moves").dotted());
assert!(drawn.to_mermaid().ends_with("a -.->|moves| b"));

Fields

from: String

The id of the node the arrow leaves.

to: String

The id of the node the arrow reaches.

label: Option<String>

What is written on the arrow, when anything is.

style: EdgeStyle

Whether it happens or is implied.

Implementations

impl Edge

pub fn new(from: impl Into<String>, to: impl Into<String>) -> Edge

A plain, unlabelled arrow between two node ids.

use majordomus_cli::diagram::{Edge, EdgeStyle};
let edge = Edge::new("active", "failed");
assert_eq!(edge.label, None);
assert_eq!(edge.style, EdgeStyle::Solid);

pub fn labelled(self, label: impl Into<String>) -> Edge

The same arrow with text on it: the command, the event, the condition.

use majordomus_cli::diagram::Edge;
let edge = Edge::new("active", "failed").labelled("finish --outcome failed");
assert_eq!(edge.label.as_deref(), Some("finish --outcome failed"));

pub fn dotted(self) -> Edge

The same arrow, implied rather than travelled.

use majordomus_cli::diagram::{Edge, EdgeStyle};
assert_eq!(Edge::new("a", "b").dotted().style, EdgeStyle::Dotted);

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<'de> Deserialize<'de> for Edge

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Edge

impl JsonSchema for Edge

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 Edge

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

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

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 Edge