Adr

Struct Adr 

Source
pub struct Adr {
    pub id: String,
    pub commit: String,
    pub frontmatter: AdrFrontmatter,
    pub body: String,
}
Expand description

An Architecture Decision Record.

Fields§

§id: String

Unique identifier (typically ADR-NNNN format).

§commit: String

The git commit this ADR is attached to.

§frontmatter: AdrFrontmatter

Frontmatter metadata.

§body: String

Markdown body content.

Implementations§

Source§

impl Adr

Source

pub fn new(id: String, title: String) -> Self

Create a new ADR with the given ID and title.

Source

pub fn from_markdown( id: String, commit: String, content: &str, ) -> Result<Self, Error>

Parse an ADR from markdown content with YAML frontmatter.

§Errors

Returns an error if the frontmatter is invalid or missing.

Source

pub fn to_markdown(&self) -> Result<String, Error>

Render the ADR as markdown with YAML frontmatter.

§Errors

Returns an error if serialization fails.

Source

pub fn title(&self) -> &str

Get the ADR title.

Source

pub const fn status(&self) -> &AdrStatus

Get the ADR status.

Source

pub fn has_tag(&self, tag: &str) -> bool

Check if this ADR has the given tag.

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

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.

§

impl<T> Pointable for T

§

const ALIGN: usize

The alignment of pointer.
§

type Init = T

The type for initializers.
§

unsafe fn init(init: <T as Pointable>::Init) -> usize

Initializes a with the given initializer. Read more
§

unsafe fn deref<'a>(ptr: usize) -> &'a T

Dereferences the given pointer. Read more
§

unsafe fn deref_mut<'a>(ptr: usize) -> &'a mut T

Mutably dereferences the given pointer. Read more
§

unsafe fn drop(ptr: usize)

Drops the object pointed to by the given pointer. Read more
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.
§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

§

fn vzip(self) -> V