Struct IntentRecord 

pub struct IntentRecord {
    pub id: String,
    pub source: String,
    pub title: String,
    pub statement: String,
    pub invariants: Vec<String>,
    pub satisfaction: Vec<CriterionRecord>,
    pub milestones: Vec<String>,
    pub governance: Vec<String>,
    pub non_goals: Vec<String>,
    pub cancelled: bool,
    pub superseded_by: String,
}

One intent as its file declares it: the statement that must become true, the invariants that must stay true, the milestones that realise it and the criteria that settle it. Nothing derived is stored here.

use majordomus_cli::intent::IntentRecord;
let r = IntentRecord::from_metadata(".ai/repo/project/intents/x.yaml", &serde_json::json!({
    "id": "x", "title": "X", "statement": "It becomes true.", "milestones": ["m"],
    "satisfaction": [{"id": "c", "criterion": "c", "evidence": "test", "ref": "t"}],
}));
assert_eq!(r.id, "x");
assert!(!r.cancelled);

Fields

id: String

The identity.

source: String

Repository-relative path of the file.

title: String

One line.

statement: String

What must become true.

invariants: Vec<String>

What must stay true.

satisfaction: Vec<CriterionRecord>

The criteria.

milestones: Vec<String>

Milestone ids.

governance: Vec<String>

Governance references.

non_goals: Vec<String>

What is deliberately not required.

cancelled: bool

Abandoned.

superseded_by: String

The replacement, when there is one.

Implementations

impl IntentRecord

pub fn from_metadata(source: &str, meta: &Value) -> IntentRecord

The record an object of kind intent carries. The schema has already refused a malformed file by the time the index holds it, so this reads values, never guesses.

use majordomus_cli::intent::IntentRecord;
use serde_json::json;
let r = IntentRecord::from_metadata(
    ".ai/repo/project/intents/x.yaml",
    &json!({"id": "x", "title": "X", "milestones": ["m"],
            "satisfaction": [{"id": "c", "criterion": "c", "evidence": "test",
                              "ref": "test/cases/1_x.sh"}]}),
);
assert_eq!(r.milestones, ["m"]);
assert_eq!(r.satisfaction[0].reference, "test/cases/1_x.sh");

pub fn all(index: &Index) -> Vec<IntentRecord>

Every intent record an index holds, in identity order, so nothing downstream depends on the order the files were read.

use majordomus_cli::index::Index;
use majordomus_cli::intent::IntentRecord;
let records = IntentRecord::all(index);
assert!(records.windows(2).all(|w| w[0].id <= w[1].id));

Trait Implementations

impl Clone for IntentRecord

fn clone(&self) -> IntentRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for IntentRecord

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

Formats the value using the given formatter.

impl Default for IntentRecord

fn default() -> IntentRecord

Returns the “default value” for a type.

impl Eq for IntentRecord

impl PartialEq for IntentRecord

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