Enum Origin 

pub enum Origin {
    Local,
    Ci,
    Release,
}

Where a run happened. The canonical model is provider-neutral: a CI adapter records Ci, and nothing here knows or cares which CI it was.

use majordomus_cli::evidence::Origin;

assert_eq!(Origin::parse("CI"), Some(Origin::Ci));
assert_eq!(Origin::parse("local"), Some(Origin::Local));
// naming the provider is the adapter's business; the ledger records the kind of run,
// so a repository that changes CI does not change what its old evidence says
assert!(Origin::parse("github-actions").is_none());

Example

use majordomus_cli::evidence::Origin;
assert_eq!(Origin::parse("ci"), Some(Origin::Ci));
assert_eq!(Origin::parse("nowhere"), None);

Variants

Local

Someone ran it on their own machine.

Ci

A continuous-integration run.

Release

A release run.

Implementations

impl Origin

pub fn parse(word: &str) -> Option<Origin>

Read an origin from the word a recorder was given, or None when it names none of the three.

The asymmetry with Outcome::parse is deliberate. An unreadable outcome still has to be recorded as something, and the safe something is an error; an unreadable origin is a caller passing a word this model does not have, which is worth refusing at the boundary rather than recording as a local run nobody made.

use majordomus_cli::evidence::Origin;
assert_eq!(Origin::parse(" Release "), Some(Origin::Release));
assert!(Origin::parse("laptop").is_none());

Trait Implementations

impl Clone for Origin

fn clone(&self) -> Origin

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Origin

impl Debug for Origin

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Origin

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for Origin

impl JsonSchema for Origin

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 Origin

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

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

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

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 Origin