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
impl Adr
Sourcepub fn new(
id: AdrId,
filename: String,
source_path: PathBuf,
frontmatter: Frontmatter,
body_markdown: String,
body_html: String,
body_text: String,
) -> Self
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.
Sourcepub fn source_path(&self) -> &PathBuf
pub fn source_path(&self) -> &PathBuf
Returns the source file path.
Sourcepub fn frontmatter(&self) -> &Frontmatter
pub fn frontmatter(&self) -> &Frontmatter
Returns the parsed frontmatter.
Sourcepub fn body_markdown(&self) -> &str
pub fn body_markdown(&self) -> &str
Returns the raw markdown body.
Sourcepub fn description(&self) -> &str
pub fn description(&self) -> &str
Returns the ADR description.
Returns the ADR tags.
Returns the ADR author.
Sourcepub fn technologies(&self) -> &[String]
pub fn technologies(&self) -> &[String]
Returns the technologies affected by this ADR.
Returns the related ADR filenames.
Trait Implementations§
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> BorrowMut<T> for Twhere
T: ?Sized,
impl<T> BorrowMut<T> for Twhere
T: ?Sized,
Source§fn borrow_mut(&mut self) -> &mut T
fn borrow_mut(&mut self) -> &mut T
Mutably borrows from an owned value. Read more