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.

If a config file (adrs.toml or .adr-dir) already exists at root and its configured adr_dir already matches the resolved directory, the file is left untouched – including settings this function does not otherwise know about, such as default_status, templates, generate, export, and doctor. Otherwise a fresh config is written for the resolved directory and mode, as before.

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_mode(self, mode: ConfigMode) -> Self

Override the configuration mode.

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 list_with_errors(&self) -> Result<(Vec<Adr>, Vec<(PathBuf, Error)>)>

List all ADRs, also returning parse errors for files that look like ADRs but failed to parse.

This is used by the doctor command to report files that could not be parsed (e.g., invalid frontmatter).

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 renumber( &self, from: u32, to: u32, file: Option<&Path>, dry_run: bool, ) -> Result<RenumberResult>

Repair a duplicate or misassigned ADR number by moving from to to.

Renumbering touches four things and gets all four right in a single pass: the filename, the record’s own frontmatter number (nextgen) and H1 heading, and every other record’s inbound reference to it (frontmatter links[].target and rendered body markdown links). Records are edited surgically in place – never re-rendered from a template – so hand-written content that doesn’t round-trip through the template survives (see #310).

Preconditions (checked before any write)

1. from is resolved via Self::list, not Self::get, because get silently returns only the first match for a number and the motivating scenario is a duplicate number. Zero matches is an error. More than one match with no file given is an error listing every candidate path. If file is given, it must match one of the candidates.
2. from == to is a no-op: returns immediately with RenumberResult::no_op set, before any occupancy check.
3. to must be free. If occupied, the error names the occupying record and suggests the smallest free number.

Writes

When dry_run is false and every precondition passes: the file is renamed, the record’s own frontmatter number and H1 are updated, and every other record whose frontmatter links or body markdown links reference the old number/filename are rewritten. A record with no reference to from at all is left byte-for-byte untouched. CRLF line endings are preserved throughout (see #339/#340).

After a successful renumber (dry run or not), the rest of the repository root is scanned for the old filename outside the ADR directory (skipping .git, target, node_modules); matches are reported in RenumberResult::prose_warnings but never rewritten.

With dry_run: true, nothing on disk changes; the returned RenumberResult describes exactly what would have happened.

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

Update an existing ADR.

When body is non-empty, only the listed body sections are patched in place; metadata bytes on disk are left unchanged. When body is empty, metadata (status, links, tags, and MADR 4.0.0 frontmatter fields) is updated via the same path as Self::update_metadata.

Empty body does not re-render context/decision/consequences from adr (unlike the pre-BodySectionPatch API). Mutating those fields on adr and calling update(&adr, BodySectionPatch::default()) writes metadata only; body text on disk is unchanged. Pass the new text in body to patch sections.

adr.title and adr.date are not written by this method.

Unlisted body sections are left byte-for-byte unchanged on disk, including MADR ### Consequences / ### Confirmation subsections under ## Decision Outcome.

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.

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

Update only the metadata (status, links, tags) of an existing ADR file, preserving all other content byte-for-byte.

Trait Implementations

impl Debug for Repository

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

Formats the value using the given formatter.