Struct RulesReport 

pub struct RulesReport {
    pub head: Option<String>,
    pub working_tree: String,
    pub verdict: RulesVerdict,
    pub rules: Vec<RuleProof>,
    pub states: BTreeMap<String, usize>,
    pub coverage: Coverage,
    pub findings: Vec<Finding>,
    pub satisfied: bool,
}

The whole rule corpus, verified.

Example

The whole corpus joined to the tree and the ledger. verdict is what the corpus can be said to prove; satisfied is only that there are no findings, and the two differ whenever a blocking rule has never been run.

use majordomus_cli::rules::{RulesReport, RulesVerdict};
let r = RulesReport {
    head: None,
    working_tree: "clean".into(),
    verdict: RulesVerdict::Unproven,
    rules: vec![],
    states: Default::default(),
    coverage: Default::default(),
    findings: vec![],
    satisfied: true,
};
assert!(r.satisfied());
assert_ne!(r.verdict, RulesVerdict::Proven, "no findings is not proof");

Fields

head: Option<String>

The commit the report was derived against, when git could say.

working_tree: String

clean, dirty or unknown at the time of derivation.

verdict: RulesVerdict

What the whole corpus proves: proven, unproven or failing. Derived over the whole corpus before any filter, like the tallies.

rules: Vec<RuleProof>

Every rule, in canonical id order.

states: BTreeMap<String, usize>

How many rules are in each state, by the state’s printed word.

coverage: Coverage

The parts of a proof, counted.

findings: Vec<Finding>

Every rule whose declared class the proof does not support.

satisfied: bool

Whether there are no findings — and nothing more. A corpus none of whose blocking rules was ever run is satisfied; verdict is the field that says whether anything was proven.

Implementations

impl RulesReport

pub fn satisfied(&self) -> bool

Are there no findings? Not whether anything is proven: that is RulesReport::verdict.

Trait Implementations

impl Clone for RulesReport

fn clone(&self) -> RulesReport

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RulesReport

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RulesReport

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for RulesReport

impl JsonSchema for RulesReport

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 PartialEq for RulesReport

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

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 RulesReport