Struct RuleProof 

pub struct RuleProof {
    pub rule: RuleDefinition,
    pub validator: Option<ValidatorRef>,
    pub tests: Vec<TestProof>,
    pub gates: Vec<String>,
    pub required_by: Vec<String>,
    pub state: RuleState,
    pub meaning: String,
    pub satisfied: bool,
}

One rule, joined to everything the repository can show about it.

Example

A RuleProof is what report produces per rule; satisfied is whether the state supports the class the rule declares, which is the whole question.

use majordomus_cli::rules::{report, RuleProof, RuleState};
use majordomus_cli::evidence::Ledger;
use majordomus_cli::synthetic::SyntheticRepository;
let repo = SyntheticRepository::small().unwrap();
let ledger = Ledger::load(repo.root()).unwrap();
let r = report(&repo.index().unwrap(), &ledger);
let first: &RuleProof = &r.rules[0];
assert_eq!(first.state, RuleState::Unproven);
assert!(first.satisfied, "an advisory rule owes no executable proof");

Fields

rule: RuleDefinition

The canonical definition.

validator: Option<ValidatorRef>

The validator, when the mode is dispatched.

tests: Vec<TestProof>

Every test the rule names, joined to the ledger.

gates: Vec<String>

Every CI gate that runs something this rule names, deduplicated.

required_by: Vec<String>

The rules that depend on this one, by id — the converse of depends_on, which no rule declares and which a reader always wants.

state: RuleState

What the repository can say, as a whole.

meaning: String

That state, in one sentence.

satisfied: bool

Whether the state is one this rule’s class can live with.

Trait Implementations

impl Clone for RuleProof

fn clone(&self) -> RuleProof

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RuleProof

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RuleProof

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RuleProof

impl JsonSchema for RuleProof

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 Ordered for RuleProof

A proof is ordered by the rule it is about: one comparator, so a filtered report and the whole report cannot disagree about the sequence.

fn order_key(&self) -> OrderKey<'_>

The four parts this item is ordered by. Borrowed from the item: building a key allocates nothing, so sorting a large collection costs the comparisons and no more.

impl PartialEq for RuleProof

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

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 RuleProof