Struct RawFrontmatter 

pub struct RawFrontmatter {

    pub id: String,
    pub item_type: ItemType,
    pub name: String,
    pub description: Option<String>,
    pub refines: Vec<String>,
    pub derives_from: Vec<String>,
    pub satisfies: Vec<String>,
    pub is_refined_by: Vec<String>,
    pub derives: Vec<String>,
    pub is_satisfied_by: Vec<String>,
    pub specification: Option<String>,
    pub depends_on: Vec<String>,
    pub platform: Option<String>,
    pub justified_by: Option<Vec<String>>,
}

Raw frontmatter structure for deserialization.

This represents the YAML frontmatter as it appears in Markdown files. All relationship fields accept both single values and arrays for flexibility.

Fields

id: String

Unique identifier (required).

item_type: ItemType

Item type (required).

name: String

Human-readable name (required).

description: Option<String>

Optional description.

refines: Vec<String>

Items this item refines (for UseCase, Scenario).

derives_from: Vec<String>

Items this item derives from (for SystemRequirement, HW/SW Requirement).

satisfies: Vec<String>

Items this item satisfies (for SystemArchitecture, HW/SW DetailedDesign).

is_refined_by: Vec<String>

Items that refine this item (for Solution, UseCase).

derives: Vec<String>

Items derived from this item (for Scenario, SystemArchitecture).

is_satisfied_by: Vec<String>

Items that satisfy this item (for SystemRequirement, HW/SW Requirement).

specification: Option<String>

Specification statement (required for requirement types).

depends_on: Vec<String>

Peer dependencies (for requirement types).

platform: Option<String>

Target platform (for SystemArchitecture).

justified_by: Option<Vec<String>>

ADR links (reserved for future use).

Implementations

impl RawFrontmatter

pub fn upstream_refs(&self) -> Result<UpstreamRefs, ParseError>

Converts string IDs to ItemIds for upstream refs.

pub fn downstream_refs(&self) -> Result<DownstreamRefs, ParseError>

Converts string IDs to ItemIds for downstream refs.

pub fn attributes(&self) -> ItemAttributes

Converts to ItemAttributes.

Trait Implementations

impl Clone for RawFrontmatter

fn clone(&self) -> RawFrontmatter

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RawFrontmatter

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for RawFrontmatter

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.