Struct AdrDoc 

pub struct AdrDoc {
    pub meta: AdrMeta,
    pub path: String,
    pub sections: Vec<Section>,
    pub preamble: String,
    pub links: Vec<WikiLink>,
    pub versions: VersionFacts,
}

A fully-parsed ADR: metadata, section structure, and authored links.

Fields

meta: AdrMeta

Frontmatter metadata.

path: String

Repository-relative path of the ADR file.

sections: Vec<Section>

## sections in document order.

preamble: String

The body text before the first ## heading — in house style, the # title and the summary table — verbatim and uncapped, with surrounding blank lines trimmed (the same rule the sections use, see Section::text).

This is the only part of an ADR that belongs to no section, which is exactly why the adr node carries it and not the whole document: the sections already hold the body between them, so nothing is stored twice. The whole document, for a reader who wants it, is on the file: node.

links: Vec<WikiLink>

Authored [[…]] links in document order.

versions: VersionFacts

What the document says about its own version, in three places.

Implementations

impl AdrDoc

pub fn key(&self) -> String

The natural key of this ADR’s node (adr:<id>).

pub fn text_for_key(&self, key: &str) -> Option<&str>

The full, uncapped text the node key should show, or None if key names no part of this ADR (or names an empty one).

The inverse of the key grammar Self::key and Self::facts build, and deliberately their neighbour: a renderer that re-split adr:0015#consequences with its own rule would be reimplementing the thing it is trying to read.

The split is the point. adr:0015 gets its preamble and a section gets its own span — never the whole document, which is what a path-only rule would hand to all twenty ADR notes and all 179 section notes alike, beside the file: note that already carries it once.

pub fn facts(&self) -> FactSet

The authored nodes and structural edges for this ADR: an adr node, one adr_section node per section, and contains edges between them. Wiki links are not included — they are validated against the code graph by [crate::check] before becoming edges.

Trait Implementations

impl Clone for AdrDoc

fn clone(&self) -> AdrDoc

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for AdrDoc

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

Formats the value using the given formatter.

impl Eq for AdrDoc

impl PartialEq for AdrDoc

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for AdrDoc