Struct Adr 

pub struct Adr {

    pub number: u32,
    pub title: String,
    pub date: Date,
    pub status: AdrStatus,
    pub links: Vec<AdrLink>,
    pub decision_makers: Vec<String>,
    pub consulted: Vec<String>,
    pub informed: Vec<String>,
    pub tags: Vec<String>,
    pub context: String,
    pub decision: String,
    pub consequences: String,
    pub path: Option<PathBuf>,
}

An Architecture Decision Record.

Fields

number: u32

The ADR number (e.g., 1, 2, 3).

title: String

The title of the decision.

date: Date

The date the decision was made.

status: AdrStatus

The current status of the decision.

links: Vec<AdrLink>

Links to other ADRs.

decision_makers: Vec<String>

People who made the decision (MADR 4.0.0).

consulted: Vec<String>

People consulted for input (MADR 4.0.0). Two-way communication - their opinions are sought.

informed: Vec<String>

People kept informed (MADR 4.0.0). One-way communication - they are kept up-to-date.

tags: Vec<String>

Tags for categorization.

context: String

The context section (why this decision was needed).

decision: String

The decision section (what was decided).

consequences: String

The consequences section (what happens as a result).

path: Option<PathBuf>

Path to the ADR file (not serialized to frontmatter).

Implementations

impl Adr

pub fn new(number: u32, title: impl Into<String>) -> Self

Create a new ADR with the given number and title.

pub fn filename(&self) -> String

Returns the formatted filename for this ADR.

pub fn full_title(&self) -> String

Returns the full title with number prefix (e.g., “1. Use Rust”).

pub fn add_link(&mut self, link: AdrLink)

Add a link to another ADR.

pub fn set_status(&mut self, status: AdrStatus)

Set the status and optionally record what this supersedes.

pub fn set_decision_makers(&mut self, makers: Vec<String>)

Set the decision makers (MADR 4.0.0).

pub fn add_decision_maker(&mut self, maker: impl Into<String>)

Add a decision maker (MADR 4.0.0).

pub fn set_consulted(&mut self, consulted: Vec<String>)

Set the consulted people (MADR 4.0.0).

pub fn add_consulted(&mut self, person: impl Into<String>)

Add a consulted person (MADR 4.0.0).

pub fn set_informed(&mut self, informed: Vec<String>)

Set the informed people (MADR 4.0.0).

pub fn add_informed(&mut self, person: impl Into<String>)

Add an informed person (MADR 4.0.0).

pub fn set_tags(&mut self, tags: Vec<String>)

Set the tags for categorization.

pub fn add_tag(&mut self, tag: impl Into<String>)

Add a tag for categorization.

Trait Implementations

impl Clone for Adr

fn clone(&self) -> Adr

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Adr

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Adr

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<&Adr> for JsonAdr

fn from(adr: &Adr) -> Self

Converts to this type from the input type.

impl PartialEq for Adr

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Serialize for Adr

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Eq for Adr

impl StructuralPartialEq for Adr