Struct PlanDocument 

pub struct PlanDocument {
    pub schema_version: u32,
    pub generator: Generator,
    pub source: Source,
    pub stats: Stats,
    pub files: Vec<FileEntry>,
    pub hunks: Vec<HunkEntry>,
    pub classes: Vec<ClassEntry>,
    pub groups: Option<Vec<Group>>,
    pub reading_plan: Option<Vec<ReadingStep>>,
    pub audit: Audit,
    pub symbols: Option<SymbolIndex>,
}

The one JSON document: a grouped, ordered reading plan for a diff.

Fields

schema_version: u32

generator: Generator

source: Source

stats: Stats

files: Vec<FileEntry>

hunks: Vec<HunkEntry>

classes: Vec<ClassEntry>

groups: Option<Vec<Group>>

None until the grouping stage runs. Some(vec![]) is a bug, not a state.

reading_plan: Option<Vec<ReadingStep>>

None until the grouping stage runs; ordered foundation-first once present.

audit: Audit

symbols: Option<SymbolIndex>

Symbol-level dependency sites: which token resolves to which declaration. Produced by classify, beside the class graph.

None on a document written before this field existed. It is additive, so schema_version stays 3 — but a stored artefact does get re-read (dfr agent --doc, the grouping cache), which is why this defaults rather than requiring the key.

Implementations

impl PlanDocument

pub fn from_json(s: &str) -> Result<Self, SchemaError>

Parse and enforce the version gate. Use this instead of raw serde_json.

pub fn to_json_pretty(&self) -> Result<String, SchemaError>

pub fn to_json(&self) -> Result<String, SchemaError>

Trait Implementations

impl Clone for PlanDocument

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for PlanDocument

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for PlanDocument

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for PlanDocument

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl Serialize for PlanDocument

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 PlanDocument