Struct ImpliedObligation 

pub struct ImpliedObligation {
    pub id: String,
    pub title: String,
    pub applicable: bool,
    pub declared: bool,
    pub reason: String,
    pub because: Vec<String>,
    pub remediation: String,
}

use majordomus_cli::gates::ImpliedObligation;

let owed = ImpliedObligation {
    id: "tests".into(),
    title: "The cases the change obliges were run".into(),
    applicable: true,
    declared: false,
    reason: "lib/check.sh is an input of this obligation".into(),
    because: vec!["lib/check.sh".into()],
    remediation: "majordomus start --requires tests".into(),
};
// applicable and undeclared is the gap nothing else reports: the change owes it and
// the task promised nothing, so no validator holds anybody to it
assert!(owed.applicable && !owed.declared);

One obligation the change set implies, and whether the task promised it.

Applicability is derived and nothing else: a token’s own inputs in share/obligations.yaml name the files it is about, so a change to one of them is what makes the token owed. A token with no inputs names a fact outside the tree — a push, a publication, a deployment — which no change to a tree can imply, so those are owed when the task declares them and reported as not applicable when it does not.

Fields

id: String

The token.

title: String

The obligation as a heading, from the vocabulary.

applicable: bool

True when the change set, or the task’s own declaration, makes it owed.

declared: bool

True when the task’s requires names it, so finish already holds the task to it.

reason: String

Why it applies, or why it does not.

because: Vec<String>

The changed paths that implied it, when paths did.

remediation: String

What would discharge it.

Trait Implementations

impl Clone for ImpliedObligation

fn clone(&self) -> ImpliedObligation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ImpliedObligation

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ImpliedObligation

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl JsonSchema for ImpliedObligation

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 Serialize for ImpliedObligation

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

where __S: Serializer,

Serialize this value into the given Serde serializer.