Struct Config 

pub struct Config {
    pub allow_unrecognised: bool,
    pub allow_invalid: bool,
    pub subfolders_are_namespaces: bool,
    /* private fields */
}

Configuration for requirements management.

This struct holds settings that control how requirements are managed, including HRID formatting, directory structure modes, and validation rules.

Fields

allow_unrecognised: bool

Whether to allow the requirements directory to contain markdown files with names that are not valid HRIDs

allow_invalid: bool

Whether to allow markdown files with names that are valid HRIDs that are not correctly formatted

subfolders_are_namespaces: bool

Whether subfolder paths contribute to the namespace of requirements.

When false (default): The full HRID is encoded in the filename. Example: system/auth/REQ-001.md -> HRID is parsed as REQ-001 Example: custom/system-auth-REQ-001.md -> HRID is system-auth-REQ-001

When true: Subfolders encode the namespace, filename contains KIND-ID. Example: system/auth/REQ-001.md -> HRID is system-auth-REQ-001 Example: system/auth/USR/001.md -> HRID is system-auth-USR-001 (The format is inferred: numeric filename means KIND in parent folder)

Implementations

impl Config

pub fn load(path: &Path) -> Result<Self, String>

Loads the configuration from a TOML file at the given path.

Errors

Returns an error if the file cannot be read or if the TOML content is invalid.

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

Saves the configuration to a TOML file at the given path.

Errors

Returns an error if the configuration cannot be serialized to TOML or if the file cannot be written.

pub const fn digits(&self) -> usize

Returns the number of digits for padding HRID IDs.

pub fn allowed_kinds(&self) -> &[String]

Returns the allowed kinds, if configured.

pub const fn set_subfolders_are_namespaces(&mut self, value: bool)

Sets the subfolders_are_namespaces configuration option.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for Config

fn eq(&self, other: &Config) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl Eq for Config

impl StructuralPartialEq for Config