Struct SourcedConfig 

pub struct SourcedConfig<State = ConfigLoaded> {
    pub global: SourcedGlobalConfig,
    pub per_file_ignores: SourcedValue<HashMap<String, Vec<String>>>,
    pub per_file_flavor: SourcedValue<IndexMap<String, MarkdownFlavor>>,
    pub rules: BTreeMap<String, SourcedRuleConfig>,
    pub loaded_files: Vec<String>,
    pub unknown_keys: Vec<(String, String, Option<String>)>,
    pub project_root: Option<PathBuf>,
    pub validation_warnings: Vec<ConfigValidationWarning>,
    /* private fields */
}

Configuration with provenance tracking for values.

The State type parameter encodes the validation state:

• ConfigLoaded: Config has been loaded but not validated
• ConfigValidated: Config has been validated and can be converted to Config

Typestate Pattern

This uses the typestate pattern to ensure validation happens before conversion:

let loaded: SourcedConfig<ConfigLoaded> = SourcedConfig::load_with_discovery(...)?;
let validated: SourcedConfig<ConfigValidated> = loaded.validate(&registry)?;
let config: Config = validated.into();  // Only works on ConfigValidated!

Attempting to convert a ConfigLoaded config directly to Config is a compile error.

Fields

global: SourcedGlobalConfig

per_file_ignores: SourcedValue<HashMap<String, Vec<String>>>

per_file_flavor: SourcedValue<IndexMap<String, MarkdownFlavor>>

rules: BTreeMap<String, SourcedRuleConfig>

loaded_files: Vec<String>

unknown_keys: Vec<(String, String, Option<String>)>

project_root: Option<PathBuf>

Project root directory (parent of config file), used for resolving relative paths

validation_warnings: Vec<ConfigValidationWarning>

Validation warnings (populated after validate() is called)

Implementations

impl SourcedConfig<ConfigLoaded>

pub fn load( config_path: Option<&str>, cli_overrides: Option<&SourcedGlobalConfig>, ) -> Result<Self, ConfigError>

Load and merge configurations from files and CLI overrides.

pub fn load_with_discovery( config_path: Option<&str>, cli_overrides: Option<&SourcedGlobalConfig>, skip_auto_discovery: bool, ) -> Result<Self, ConfigError>

Load and merge configurations from files and CLI overrides. If skip_auto_discovery is true, only explicit config paths are loaded.

pub fn validate( self, registry: &RuleRegistry, ) -> Result<SourcedConfig<ConfigValidated>, ConfigError>

Validate the configuration against a rule registry.

This method transitions the config from ConfigLoaded to ConfigValidated state, enabling conversion to Config. Validation warnings are stored in the config and can be displayed to the user.

Example

let loaded = SourcedConfig::load_with_discovery(path, None, false)?;
let validated = loaded.validate(&registry)?;
let config: Config = validated.into();

pub fn validate_into( self, registry: &RuleRegistry, ) -> Result<(Config, Vec<ConfigValidationWarning>), ConfigError>

Validate and convert to Config in one step (convenience method).

This combines validate() and into() for callers who want the validation warnings separately.

pub fn into_validated_unchecked(self) -> SourcedConfig<ConfigValidated>

Skip validation and convert directly to ConfigValidated state.

Safety

This method bypasses validation. Use only when:

• You’ve already validated via validate_config_sourced()
• You’re in test code that doesn’t need validation
• You’re migrating legacy code and will add proper validation later

Prefer validate() for new code.

Trait Implementations

impl<State: Clone> Clone for SourcedConfig<State>

fn clone(&self) -> SourcedConfig<State>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<State: Debug> Debug for SourcedConfig<State>

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

Formats the value using the given formatter.

impl Default for SourcedConfig<ConfigLoaded>

fn default() -> Self

Returns the “default value” for a type.

impl From<SourcedConfig<ConfigValidated>> for Config

Convert a validated configuration to the final Config type.

This implementation only exists for SourcedConfig<ConfigValidated>, ensuring that validation must occur before conversion.

fn from(sourced: SourcedConfig<ConfigValidated>) -> Self

Converts to this type from the input type.