Struct RenumberResult 

#[non_exhaustive]
pub struct RenumberResult {
    pub from: u32,
    pub to: u32,
    pub no_op: bool,
    pub renamed_file: Option<(PathBuf, PathBuf)>,
    pub frontmatter_updated: bool,
    pub h1_updated: bool,
    pub updated_references: Vec<PathBuf>,
    pub prose_warnings: Vec<PathBuf>,
    pub ambiguous_references: Vec<PathBuf>,
}

Describes what Repository::renumber changed (or, with dry_run: true, would change) so the caller can print a plan or a report without needing to inspect the filesystem itself.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

from: u32

The source number.

to: u32

The destination number.

no_op: bool

True when from == to; every other field is left at its default.

renamed_file: Option<(PathBuf, PathBuf)>

The renumbered record’s old and new file paths.

frontmatter_updated: bool

True when the record’s own frontmatter number field was rewritten (nextgen mode only).

h1_updated: bool

True when the record’s own H1 heading was rewritten. Nygard-style templates number the H1 (# 3. Title); MADR’s bare # Title has no number and is never rewritten.

updated_references: Vec<PathBuf>

Paths of other records whose inbound references (frontmatter links[].target and/or a rendered body markdown link) were rewritten to point at to instead of from.

prose_warnings: Vec<PathBuf>

Paths outside the ADR directory that still mention the old filename. Informational only – never rewritten.

ambiguous_references: Vec<PathBuf>

Paths of records holding a frontmatter links[].target equal to from that were deliberately left alone because from was a duplicate, so the reference could have meant either record. Informational only.

Trait Implementations

impl Clone for RenumberResult

fn clone(&self) -> RenumberResult

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RenumberResult

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

Formats the value using the given formatter.

impl Default for RenumberResult

fn default() -> RenumberResult

Returns the “default value” for a type.