Struct Config 

pub struct Config {
    pub adr_dir: PathBuf,
    pub mode: ConfigMode,
    pub templates: TemplateConfig,
}

Configuration for an ADR repository.

Fields

adr_dir: PathBuf

The directory where ADRs are stored.

mode: ConfigMode

The mode of operation.

templates: TemplateConfig

Template configuration.

Implementations

impl Config

pub fn load(root: &Path) -> Result<Self>

Load configuration from the given directory.

Searches for configuration in the following order:

1. adrs.toml (new format)
2. .adr-dir (legacy adr-tools format)
3. Default configuration

pub fn load_or_default(root: &Path) -> Self

Load configuration, or return default if not found.

pub fn save(&self, root: &Path) -> Result<()>

Save configuration to the given directory.

pub fn adr_path(&self, root: &Path) -> PathBuf

Returns the full path to the ADR directory.

pub fn is_next_gen(&self) -> bool

Returns true if running in next-gen mode.

pub fn merge(&mut self, other: &Config)

Merge another config into this one (other takes precedence for set values).

Trait Implementations

impl Clone for Config

fn clone(&self) -> Config

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Config

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

Formats the value using the given formatter.

impl Default for Config

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Config

where Config: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Config

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.