Struct FafData 

pub struct FafData {

    pub faf_version: String,
    pub project: Project,
    pub ai_score: Option<String>,
    pub ai_confidence: Option<String>,
    pub ai_tldr: Option<HashMap<String, String>>,
    pub instant_context: Option<InstantContext>,
    pub context_quality: Option<ContextQuality>,
    pub stack: Option<Stack>,
    pub human_context: Option<HumanContext>,
    pub preferences: Option<Preferences>,
    pub state: Option<State>,
    pub tags: Vec<String>,
    pub commands: HashMap<String, String>,
    pub security: Option<Security>,
    pub ai_instructions: Option<AiInstructions>,
    pub conventions: Vec<String>,
}

A complete parsed .faf file — the root of the context document.

Fields

faf_version: String

The .faf format version this file was written against (e.g. "2.5.0").

project: Project

Core project identity (name, goal, language). Always present.

ai_score: Option<String>

Cached AI-readiness score, if one was written by a generator.

ai_confidence: Option<String>

Cached confidence band for the score, if present.

ai_tldr: Option<HashMap<String, String>>

Short, AI-facing summary lines keyed by topic.

instant_context: Option<InstantContext>

The fast-path context an assistant reads first (what/stack/files).

context_quality: Option<ContextQuality>

Self-reported completeness metrics for the context.

stack: Option<Stack>

The technical stack (frontend, backend, database, build, …).

human_context: Option<HumanContext>

The human side — the 6 W’s (who/what/why/how/where/when).

preferences: Option<Preferences>

Working preferences (quality bar, testing, docs, code style).

state: Option<State>

Where the project is right now (phase, version, focus, milestones).

tags: Vec<String>

Free-form classification tags.

commands: HashMap<String, String>

Top-level named commands (build/test/lint/dev) → shell invocations. Some .faf files nest these under instant_context.commands instead; see FafFile::commands() for the fallback that reads either shape.

security: Option<Security>

Secrets handling guidance — what agents must never read or commit.

ai_instructions: Option<AiInstructions>

Agent-facing guardrails and working-style notes.

conventions: Vec<String>

Real repo conventions an agent should follow (not human↔assistant prefs).

Trait Implementations

impl Clone for FafData

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 FafData

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for FafData

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for FafData

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.