Trait Rule

Source

pub trait Rule:
    DynClone
    + Send
    + Sync {
Show 18 methods    // Required methods
    fn name(&self) -> &'static str;
    fn description(&self) -> &'static str;
    fn check(&self, ctx: &LintContext<'_>) -> LintResult;
    fn fix(&self, ctx: &LintContext<'_>) -> Result<String, LintError>;
    fn as_any(&self) -> &dyn Any;

    // Provided methods
    fn check_with_structure(
        &self,
        ctx: &LintContext<'_>,
        _structure: &DocumentStructure,
    ) -> LintResult { ... }
    fn check_with_ast(
        &self,
        ctx: &LintContext<'_>,
        _ast: &MarkdownAst,
    ) -> LintResult { ... }
    fn check_with_structure_and_ast(
        &self,
        ctx: &LintContext<'_>,
        _structure: &DocumentStructure,
        _ast: &MarkdownAst,
    ) -> LintResult { ... }
    fn should_skip(&self, _ctx: &LintContext<'_>) -> bool { ... }
    fn category(&self) -> RuleCategory { ... }
    fn uses_ast(&self) -> bool { ... }
    fn uses_document_structure(&self) -> bool { ... }
    fn as_maybe_document_structure(&self) -> Option<&dyn MaybeDocumentStructure> { ... }
    fn as_maybe_ast(&self) -> Option<&dyn MaybeAst> { ... }
    fn default_config_section(&self) -> Option<(String, Value)> { ... }
    fn config_aliases(&self) -> Option<HashMap<String, String>> { ... }
    fn fix_capability(&self) -> FixCapability { ... }
    fn from_config(_config: &Config) -> Box<dyn Rule>
       where Self: Sized { ... }
}

Expand description

Remove marker /// TRAIT_MARKER_V1

Required Methods§

Source

fn as_any(&self) -> &dyn Any

Provided Methods§

Source

fn check_with_structure( &self, ctx: &LintContext<'_>, _structure: &DocumentStructure, ) -> LintResult

Enhanced check method using document structure By default, calls the regular check method if not overridden

Source

fn check_with_ast( &self, ctx: &LintContext<'_>, _ast: &MarkdownAst, ) -> LintResult

AST-based check method for rules that can benefit from shared AST parsing By default, calls the regular check method if not overridden

Source

fn check_with_structure_and_ast( &self, ctx: &LintContext<'_>, _structure: &DocumentStructure, _ast: &MarkdownAst, ) -> LintResult

Combined check method using both document structure and AST By default, calls the regular check method if not overridden

Source

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

Check if this rule should quickly skip processing based on content

Source

fn category(&self) -> RuleCategory

Get the category of this rule for selective processing

Source

fn uses_ast(&self) -> bool

Check if this rule can benefit from AST parsing

Source

fn uses_document_structure(&self) -> bool

Check if this rule can benefit from document structure

Source

fn as_maybe_document_structure(&self) -> Option<&dyn MaybeDocumentStructure>

Source

fn as_maybe_ast(&self) -> Option<&dyn MaybeAst>

Source

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.

Source