Struct EconomicsFinding 

pub struct EconomicsFinding {
    pub kind: String,
    pub path: String,
    pub line: Option<usize>,
    pub detail: String,
}

One thing the check refuses. detail names the remedy, so a finding can be acted on without reading the methodology. A finding about a claim or a file rather than a line carries no line, and its JSON omits the key. The kinds:

• unsupported_quantity: a number typed into hand-written prose next to the economics vocabulary.
• claim_unsupported: a claim binding that does not hold — the bound claim is missing from docs/CLAIMS.yaml, or it is guaranteed while its metric does not stand where the binding says or its evidence is not current.
• claim_unbound: a guaranteed claim says tokens, context or cost go down and no binding ties it to a metric.
• claim_duplicate: one claim id appears more than once in docs/CLAIMS.yaml.
• declarations_unreadable: the benchmark declarations cannot be read, so no binding can be shown to hold.
• claims_unreadable: docs/CLAIMS.yaml exists and cannot be read or parsed.
• scan_failed: the prose could not be listed or a file in it could not be read, so nothing can be said to be clean.

use majordomus_cli::economics::claims::EconomicsFinding;
let finding = EconomicsFinding {
    kind: "claim_unsupported".into(),
    path: "docs/CLAIMS.yaml".into(),
    line: None,
    detail: "set the claim to planned, or record the evidence".into(),
};
let json = serde_json::to_value(&finding).unwrap();
assert!(json.get("line").is_none(), "no line, no key");
assert_eq!(serde_json::from_value::<EconomicsFinding>(json).unwrap(), finding);

Fields

kind: String

unsupported_quantity, claim_unsupported, claim_unbound, claim_duplicate, declarations_unreadable, claims_unreadable or scan_failed.

path: String

Repository-relative path.

line: Option<usize>

1-based line, when the finding is about a line.

detail: String

What was found, and what to do about it.

Trait Implementations

impl Clone for EconomicsFinding

fn clone(&self) -> EconomicsFinding

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EconomicsFinding

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for EconomicsFinding

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for EconomicsFinding

impl JsonSchema for EconomicsFinding

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 EconomicsFinding

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

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 EconomicsFinding