Struct MD073TocValidation 

pub struct MD073TocValidation { /* private fields */ }

MD073: Table of Contents Validation

This rule validates that TOC sections match the actual document headings. It can detect TOC regions via markers (<!-- toc -->...<!-- tocstop -->) or by heading patterns.

Configuration

[MD073]
# Detection method: "markers", "heading", or "both"
detection = "both"
# Minimum heading level to include (default: 2)
min-level = 2
# Maximum heading level to include (default: 4)
max-level = 4
# Whether TOC order must match document order (default: true)
enforce-order = true
# Whether to use nested indentation (default: true)
nested = true
# Anchor generation style (default: "github")
anchor-style = "github"
# Headings that indicate a TOC section
toc-headings = ["Table of Contents", "Contents", "TOC"]

Implementations

impl MD073TocValidation

pub fn new() -> Self

Create a new rule with default settings

Trait Implementations

impl Clone for MD073TocValidation

fn clone(&self) -> MD073TocValidation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MD073TocValidation

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

Formats the value using the given formatter.

impl Default for MD073TocValidation

fn default() -> Self

Returns the “default value” for a type.

impl Rule for MD073TocValidation

fn name(&self) -> &'static str

fn description(&self) -> &'static str

fn should_skip(&self, ctx: &LintContext<'_>) -> bool

Check if this rule should quickly skip processing based on content

fn check(&self, ctx: &LintContext<'_>) -> LintResult

fn fix(&self, ctx: &LintContext<'_>) -> Result<String, LintError>

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing

fn as_any(&self) -> &dyn Any

fn default_config_section(&self) -> Option<(String, Value)>

Returns the rule name and default config table if the rule has config. If a rule implements this, it MUST be defined on the impl Rule for ... block, not just the inherent impl.

fn from_config(config: &Config) -> Box<dyn Rule>

where Self: Sized,

Factory: create a rule from config (if present), or use defaults.

fn config_aliases(&self) -> Option<HashMap<String, String>>

Returns config key aliases for this rule This allows rules to accept alternative config key names for backwards compatibility

fn fix_capability(&self) -> FixCapability

Declares the fix capability of this rule

fn cross_file_scope(&self) -> CrossFileScope

Declares cross-file analysis requirements for this rule

fn contribute_to_index( &self, _ctx: &LintContext<'_>, _file_index: &mut FileIndex, )

Contribute data to the workspace index during linting

fn cross_file_check( &self, _file_path: &Path, _file_index: &FileIndex, _workspace_index: &WorkspaceIndex, ) -> LintResult

Perform cross-file validation after all files have been linted