Struct BlueprintDoc 

pub struct BlueprintDoc {
    pub path: String,
    pub title: String,
    pub sections: Vec<Section>,
    pub links: Vec<WikiLink>,
}

A fully-parsed blueprint: title, section structure, and authored links.

Fields

path: String

Repository-relative path of the blueprint file.

title: String

Title, from the first # heading (or the file stem).

sections: Vec<Section>

## sections in document order.

links: Vec<WikiLink>

Authored [[…]] links in document order.

Implementations

impl BlueprintDoc

pub fn key(&self) -> String

The natural key of this blueprint’s node (blueprint:<path>).

pub fn facts(&self) -> FactSet

The authored nodes and structural edges: a blueprint node, one blueprint_section node per section, and contains edges between them. Wiki-links are not included — [crate::check] validates them against the code graph before they become edges.

Trait Implementations

impl Clone for BlueprintDoc

fn clone(&self) -> BlueprintDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BlueprintDoc

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

Formats the value using the given formatter.

impl Eq for BlueprintDoc

impl PartialEq for BlueprintDoc

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for BlueprintDoc