Struct Adr

pub struct Adr { /* private fields */ }

An ADR (Architecture Decision Record) documents architectural decisions

Implementations

impl Adr

pub fn new( number: u32, title: String, decision_maker: String, decision_date: Option<DateTime<Utc>>, parent_id: Option<DocumentId>, tags: Vec<Tag>, archived: bool, ) -> Result<Self, DocumentValidationError>

Create a new ADR document with content rendered from template

pub fn from_parts( number: u32, title: String, decision_maker: String, decision_date: Option<DateTime<Utc>>, metadata: DocumentMetadata, content: DocumentContent, parent_id: Option<DocumentId>, tags: Vec<Tag>, archived: bool, ) -> Self

Create an ADR document from existing data (used when loading from file)

pub fn number(&self) -> u32

pub fn decision_maker(&self) -> &str

pub fn decision_date(&self) -> Option<DateTime<Utc>>

pub async fn from_file<P: AsRef<Path>>( path: P, ) -> Result<Self, DocumentValidationError>

Create an ADR document by reading and parsing a file

pub fn from_content(raw_content: &str) -> Result<Self, DocumentValidationError>

Create an ADR document from raw file content string

pub async fn to_file<P: AsRef<Path>>( &self, path: P, ) -> Result<(), DocumentValidationError>

Write the ADR document to a file

pub fn to_content(&self) -> Result<String, DocumentValidationError>

Convert the ADR document to its markdown string representation using templates

Trait Implementations

impl Debug for Adr

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

Formats the value using the given formatter.

impl Document for Adr

fn id(&self) -> DocumentId

ADRs have special ID format: number-slug

fn document_type(&self) -> DocumentType

Get the document type

fn title(&self) -> &str

Get the document title

fn metadata(&self) -> &DocumentMetadata

Get the document metadata

fn content(&self) -> &DocumentContent

Get the document content

fn core(&self) -> &DocumentCore

Get access to the core document data

fn can_transition_to(&self, phase: Phase) -> bool

Check if this document can transition to the given phase

fn parent_id(&self) -> Option<&DocumentId>

Get the parent document ID if this document has a parent

fn blocked_by(&self) -> &[DocumentId]

Get IDs of documents that block this one

fn validate(&self) -> Result<(), DocumentValidationError>

Validate the document according to its type-specific rules

fn exit_criteria_met(&self) -> bool

Check if exit criteria are met

fn template(&self) -> DocumentTemplate

Get the template for rendering this document type

fn frontmatter_template(&self) -> &'static str

Get the frontmatter template for this document type

fn content_template(&self) -> &'static str

Get the content template for this document type

fn acceptance_criteria_template(&self) -> &'static str

Get the acceptance criteria template for this document type

fn transition_phase( &mut self, target_phase: Option<Phase>, ) -> Result<Phase, DocumentValidationError>

Transition to the next phase in sequence, or to a specific phase if provided

fn core_mut(&mut self) -> &mut DocumentCore

Get mutable access to the document core (needed for updates)

fn tags(&self) -> &[Tag]

Get the document tags

fn phase(&self) -> Result<Phase, DocumentValidationError>

Get the current phase of the document (parsed from tags)

fn update_section( &mut self, content: &str, heading: &str, append: bool, ) -> Result<(), DocumentValidationError>

Update a specific section (H2 heading) in the document content

fn update_content_body( &mut self, new_body: String, ) -> Result<(), DocumentValidationError>

Helper method for update_section to actually mutate the content

fn archived(&self) -> bool

Check if this document is archived