Adr

Struct Adr 

Source
pub struct Adr { /* private fields */ }
Expand description

A fully parsed Architecture Decision Record.

Contains the parsed frontmatter metadata, the raw markdown body, and the pre-rendered HTML body for embedding in viewers.

Implementations§

Source§

impl Adr

Source

pub fn new( id: AdrId, filename: String, source_path: PathBuf, frontmatter: Frontmatter, body_markdown: String, body_html: String, body_text: String, ) -> Self

Creates a new ADR with all components.

Source

pub fn id(&self) -> &AdrId

Returns the unique identifier.

Source

pub fn filename(&self) -> &str

Returns the filename.

Source

pub fn source_path(&self) -> &PathBuf

Returns the source file path.

Source

pub fn frontmatter(&self) -> &Frontmatter

Returns the parsed frontmatter.

Source

pub fn body_markdown(&self) -> &str

Returns the raw markdown body.

Source

pub fn body_html(&self) -> &str

Returns the pre-rendered HTML body.

Source

pub fn body_text(&self) -> &str

Returns the plain text body for search indexing.

Source

pub fn title(&self) -> &str

Returns the ADR title.

Source

pub fn description(&self) -> &str

Returns the ADR description.

Source

pub fn status(&self) -> Status

Returns the ADR status.

Source

pub fn category(&self) -> &str

Returns the ADR category.

Source

pub fn tags(&self) -> &[String]

Returns the ADR tags.

Source

pub fn author(&self) -> &str

Returns the ADR author.

Source

pub fn project(&self) -> &str

Returns the ADR project.

Source

pub fn technologies(&self) -> &[String]

Returns the technologies affected by this ADR.

Source

pub fn related(&self) -> &[String]

Returns the related ADR filenames.

Source

pub fn created(&self) -> Option<Date>

Returns the created date if available.

Source

pub fn updated(&self) -> Option<Date>

Returns the updated date if available.

Trait Implementations§

Source§

impl Clone for Adr

Source§

fn clone(&self) -> Adr

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for Adr

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Serialize for Adr

Source§

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

Serialize this value into the given Serde serializer. Read more

Auto Trait Implementations§

§

impl Freeze for Adr

§

impl RefUnwindSafe for Adr

§

impl Send for Adr

§

impl Sync for Adr

§

impl Unpin for Adr

§

impl UnwindSafe for Adr

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.