Struct Repository 

pub struct Repository { /* private fields */ }

A repository of Architecture Decision Records.

Implementations

impl Repository

pub fn open(root: impl Into<PathBuf>) -> Result<Self>

Open an existing repository at the given root.

pub fn open_or_default(root: impl Into<PathBuf>) -> Self

Open a repository, or create default config if not found.

pub fn init( root: impl Into<PathBuf>, adr_dir: Option<PathBuf>, ng: bool, ) -> Result<Self>

Initialize a new repository at the given root.

pub fn root(&self) -> &Path

Get the repository root path.

pub fn config(&self) -> &Config

Get the configuration.

pub fn adr_path(&self) -> PathBuf

Get the full path to the ADR directory.

pub fn with_template_format(self, format: TemplateFormat) -> Self

Set the template format.

pub fn with_template_variant(self, variant: TemplateVariant) -> Self

Set the template variant.

pub fn with_custom_template(self, template: Template) -> Self

Set a custom template.

pub fn list(&self) -> Result<Vec<Adr>>

List all ADRs in the repository.

pub fn next_number(&self) -> Result<u32>

Get the next available ADR number.

pub fn get(&self, number: u32) -> Result<Adr>

Find an ADR by number.

pub fn find(&self, query: &str) -> Result<Adr>

Find an ADR by query (number or fuzzy title match).

pub fn create(&self, adr: &Adr) -> Result<PathBuf>

Create a new ADR.

pub fn new_adr(&self, title: impl Into<String>) -> Result<(Adr, PathBuf)>

Create a new ADR with the given title.

pub fn supersede( &self, title: impl Into<String>, superseded: u32, ) -> Result<(Adr, PathBuf)>

Create a new ADR that supersedes another.

pub fn set_status( &self, number: u32, status: AdrStatus, superseded_by: Option<u32>, ) -> Result<PathBuf>

Change the status of an ADR.

If the new status is Superseded and superseded_by is provided, a superseded-by link will be added automatically.

pub fn link( &self, source: u32, target: u32, source_kind: LinkKind, target_kind: LinkKind, ) -> Result<()>

Link two ADRs together.

pub fn update(&self, adr: &Adr) -> Result<PathBuf>

Update an existing ADR.

pub fn read_content(&self, adr: &Adr) -> Result<String>

Read the content of an ADR file.

pub fn write_content(&self, adr: &Adr, content: &str) -> Result<PathBuf>

Write content to an ADR file.

Trait Implementations

impl Debug for Repository

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

Formats the value using the given formatter.