Struct GapRecord 

pub struct GapRecord {
    pub intent: String,
    pub source: String,
    pub observed_at: String,
    pub recorded_by: String,
    pub observations: Vec<GapObservation>,
    pub conditions: Vec<GapCondition>,
    pub risks: Vec<String>,
    pub work: Vec<GapWork>,
}

A gap record: the observations a worker made of the repository at one commit, the state of every criterion of the intent against them, the risks, and the work it suggests. One per intent, named by it.

use majordomus_cli::intent_review::GapRecord;
let g = GapRecord::from_metadata(".ai/repo/project/gaps/x.yaml", &serde_json::json!({
    "intent": "x", "observed_at": "c3f20da", "recorded_by": "claude-code",
    "conditions": [{"criterion": "a", "state": "unknown"}],
}));
assert_eq!(g.intent, "x");
assert_eq!(g.observed_at, "c3f20da");

Fields

intent: String

The intent it analyses; also the file name.

source: String

Repository-relative path.

observed_at: String

The commit the observations were made on.

recorded_by: String

Who or what recorded it.

observations: Vec<GapObservation>

The observations.

conditions: Vec<GapCondition>

One per criterion.

risks: Vec<String>

Risks, as prose.

work: Vec<GapWork>

Suggested work.

Implementations

impl GapRecord

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

The record an object of kind gap carries.

use majordomus_cli::intent_review::{ConditionState, GapRecord};
let g = GapRecord::from_metadata(".ai/repo/project/gaps/x.yaml", &serde_json::json!({
    "intent": "x", "observed_at": "abc",
    "conditions": [{"criterion": "c", "state": "missing", "observations": ["o1"]}]
}));
assert_eq!(g.conditions[0].state, Some(ConditionState::Missing));

impl GapRecord

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

Every gap record an index holds, in identity order, so the derivation does not depend on the order the files were read.

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

Trait Implementations

impl Clone for GapRecord

fn clone(&self) -> GapRecord

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for GapRecord

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for GapRecord

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for GapRecord

impl JsonSchema for GapRecord

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 GapRecord

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

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 GapRecord