Struct Config 

pub struct Config {
    pub global: GlobalConfig,
    pub per_file_ignores: HashMap<String, Vec<String>>,
    pub per_file_flavor: IndexMap<String, MarkdownFlavor>,
    pub rules: BTreeMap<String, RuleConfig>,
    pub project_root: Option<PathBuf>,
    /* private fields */
}

Represents the complete configuration loaded from rumdl.toml

Fields

global: GlobalConfig

Global configuration options

per_file_ignores: HashMap<String, Vec<String>>

Per-file rule ignores: maps file patterns to lists of rules to ignore Example: { “README.md”: [“MD033”], “docs/**/*.md”: [“MD013”] }

per_file_flavor: IndexMap<String, MarkdownFlavor>

Per-file flavor overrides: maps file patterns to Markdown flavors Example: { “docs//*.md”: MkDocs, “/*.mdx”: MDX } Uses IndexMap to preserve config file order for “first match wins” semantics

rules: BTreeMap<String, RuleConfig>

Rule-specific configurations (e.g., MD013, MD007, MD044) Each rule section can contain options specific to that rule.

Common examples:

• MD013: line_length, code_blocks, tables, headings
• MD007: indent
• MD003: style (“atx”, “atx_closed”, “setext”)
• MD044: names (array of proper names to check)

See https://github.com/rvben/rumdl for full rule documentation.

project_root: Option<PathBuf>

Project root directory, used for resolving relative paths in per-file-ignores

Implementations

impl Config

pub fn is_mkdocs_flavor(&self) -> bool

Check if the Markdown flavor is set to MkDocs

pub fn markdown_flavor(&self) -> MarkdownFlavor

Get the configured Markdown flavor

pub fn is_mkdocs_project(&self) -> bool

Legacy method for backwards compatibility - redirects to is_mkdocs_flavor

pub fn get_rule_severity(&self, rule_name: &str) -> Option<Severity>

Get the severity override for a specific rule, if configured

pub fn get_ignored_rules_for_file(&self, file_path: &Path) -> HashSet<String>

Get the set of rules that should be ignored for a specific file based on per-file-ignores configuration Returns a HashSet of rule names (uppercase, e.g., “MD033”) that match the given file path

pub fn get_flavor_for_file(&self, file_path: &Path) -> MarkdownFlavor

Get the MarkdownFlavor for a specific file based on per-file-flavor configuration. Returns the first matching pattern’s flavor, or falls back to global flavor, or auto-detects from extension, or defaults to Standard.

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() -> Config

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 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.

impl JsonSchema for Config

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for Config

fn eq(&self, other: &Self) -> 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.