Struct Provenance 

pub struct Provenance {
    pub source: String,
    pub derivation: String,
}

Where the topology came from. A diagram that cannot say this is an authored claim about the system, which is the thing this module exists to stop.

It is a required field of Diagram rather than an optional one for that reason: a reader who doubts the picture must be able to go to the file it was read out of.

use majordomus_cli::diagram::{lifecycle, Provenance};
let from = Provenance::new("lib/finish.sh", "the outcome vocabulary");
assert_eq!(from.derivation, "the outcome vocabulary");
let drawn = lifecycle("case \"$outcome\" in completed|failed) ;;").expect("derives");
assert_eq!(drawn.provenance, from, "the derivation records the file it read");

Fields

source: String

The repository-relative path the structure was read out of.

derivation: String

One line saying what was read out of it, so a reader can check the derivation against the file rather than against the picture.

Implementations

impl Provenance

pub fn new( source: impl Into<String>, derivation: impl Into<String>, ) -> Provenance

The file and what was taken from it.

use majordomus_cli::diagram::Provenance;
let from = Provenance::new("lib/finish.sh", "the outcome vocabulary");
assert_eq!(from.source, "lib/finish.sh");

Trait Implementations

impl Clone for Provenance

fn clone(&self) -> Provenance

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Provenance

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Provenance

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Provenance

impl JsonSchema for Provenance

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 Provenance

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

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

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

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 Provenance