Enum RuleState 

pub enum RuleState {
    Proven,
    InputsUnchanged,
    Stale,
    Gated,
    Failing,
    NotRun,
    Reviewed,
    Unrunnable,
    Dangling,
    Unproven,
}

What the repository can say about one rule’s proof, as a whole.

Ordered strongest to weakest so that a summary sorted by this reads as a ranking. A rule’s state is made from its parts’ by crate::evidence::freshness::aggregate: a failing part makes it failing, and otherwise the weakest part that can carry proof decides.

Example

use majordomus_cli::rules::RuleState;
assert!(RuleState::Proven < RuleState::Stale);
assert!(RuleState::Stale.passing());
assert!(!RuleState::Dangling.passing());

Variants

Proven

Every artifact it names is present, and every test it names has a passing run that nothing has invalidated.

InputsUnchanged

Every artifact is present and every test passed, but at least one run is only un-invalidated rather than measured against this tree.

Stale

A passing run exists, but something it is about has changed since.

Gated

An executable gate runs what this rule names, on every CI run that selects it. The mechanism is in the tree and wired; no verdict for it is recorded here.

Failing

The latest run of a test this rule names did not pass.

NotRun

Every artifact is present, and no run of at least one named test was ever recorded.

Reviewed

The rule declares, with a stated reason, that nothing executable can express it. An honest exemption: counted apart from every proven rule, never counted as one.

Unrunnable

The rule names a path no runner in this repository drives.

Dangling

The rule names a path that is not in the tree. A proof that does not exist is worse than no proof, because the rule reads as proven.

Unproven

The rule names neither a validator nor a test. Correct for a rule nothing executable can express; a defect for a blocking one.

Implementations

impl RuleState

pub fn label(self) -> &'static str

The word every surface prints for this state, written here once so that proven and inputs unchanged cannot be collapsed into one badge by a renderer.

use majordomus_cli::rules::RuleState;
assert_eq!(RuleState::InputsUnchanged.label(), "inputs unchanged");

pub fn meaning(self) -> &'static str

One sentence: what the state means, worded once so that every surface says the same thing rather than each inventing its own gloss.

use majordomus_cli::rules::RuleState;
assert!(RuleState::Dangling.meaning().contains("not in the tree"));

pub fn passing(self) -> bool

Does this state carry a passing execution behind it, of any freshness?

use majordomus_cli::rules::RuleState;
assert!(RuleState::Proven.passing());
assert!(!RuleState::Unproven.passing());

pub fn as_proof(self, class: Class) -> (ProofState, bool)

The one declared mapping of a rule’s state onto the evidence vocabulary, and whether that state can carry proof when a subject aggregates it.

A gate refuses violations, but no recorded run proves the behaviour, so gated reads not_run. A reviewed exemption and a rule that names nothing read no_test; only a blocking rule that names nothing drags a subject, because only for it is that a defect. A dangling path reads unrunnable and still drags.

use majordomus_cli::evidence::ProofState;
use majordomus_cli::rules::{Class, RuleState};

assert_eq!(RuleState::Gated.as_proof(Class::Blocking), (ProofState::NotRun, true));
assert_eq!(RuleState::Reviewed.as_proof(Class::Blocking), (ProofState::NoTest, false));
assert_eq!(RuleState::Unproven.as_proof(Class::Blocking), (ProofState::NoTest, true));
assert_eq!(RuleState::Unproven.as_proof(Class::Advisory), (ProofState::NoTest, false));
assert_eq!(RuleState::Dangling.as_proof(Class::Advisory), (ProofState::Unrunnable, true));

Trait Implementations

impl Clone for RuleState

fn clone(&self) -> RuleState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for RuleState

impl Debug for RuleState

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuleState

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RuleState

impl JsonSchema for RuleState

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 RuleState

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

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

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

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 RuleState