Struct LineFilterConfig 

pub struct LineFilterConfig {

    pub skip_front_matter: bool,
    pub skip_code_blocks: bool,
    pub skip_html_blocks: bool,
    pub skip_html_comments: bool,
    pub skip_mkdocstrings: bool,
    pub skip_esm_blocks: bool,
    pub skip_math_blocks: bool,
    pub skip_quarto_divs: bool,
    pub skip_jsx_expressions: bool,
    pub skip_mdx_comments: bool,
    pub skip_admonitions: bool,
    pub skip_content_tabs: bool,
    pub skip_definition_lists: bool,
}

Configuration for filtering lines during iteration

Use the builder pattern to configure which types of content should be skipped:

use rumdl_lib::filtered_lines::LineFilterConfig;

let config = LineFilterConfig::new()
    .skip_front_matter()
    .skip_code_blocks()
    .skip_html_blocks()
    .skip_html_comments()
    .skip_mkdocstrings()
    .skip_esm_blocks()
    .skip_quarto_divs();

Fields

skip_front_matter: bool

Skip lines inside front matter (YAML/TOML/JSON metadata)

skip_code_blocks: bool

Skip lines inside fenced code blocks

skip_html_blocks: bool

Skip lines inside HTML blocks

skip_html_comments: bool

Skip lines inside HTML comments

skip_mkdocstrings: bool

Skip lines inside mkdocstrings blocks

skip_esm_blocks: bool

Skip lines inside ESM (ECMAScript Module) blocks

skip_math_blocks: bool

Skip lines inside math blocks ($$ … $$)

skip_quarto_divs: bool

Skip lines inside Quarto div blocks (::: … :::)

skip_jsx_expressions: bool

Skip lines containing or inside JSX expressions (MDX: {expression})

skip_mdx_comments: bool

Skip lines inside MDX comments ({/* … */})

skip_admonitions: bool

Skip lines inside MkDocs admonitions (!!! or ???)

skip_content_tabs: bool

Skip lines inside MkDocs content tabs (=== “Tab”)

skip_definition_lists: bool

Skip lines inside definition lists (: definition)

Implementations

impl LineFilterConfig

pub fn new() -> Self

Create a new filter configuration with all filters disabled

pub fn skip_front_matter(self) -> Self

Skip lines that are part of front matter (YAML/TOML/JSON)

Front matter is metadata at the start of a markdown file and should not be processed by markdown linting rules.

pub fn skip_code_blocks(self) -> Self

Skip lines inside fenced code blocks

Code blocks contain source code, not markdown, and most rules should not process them.

pub fn skip_html_blocks(self) -> Self

Skip lines inside HTML blocks

HTML blocks contain raw HTML and most markdown rules should not process them.

pub fn skip_html_comments(self) -> Self

Skip lines inside HTML comments

HTML comments () are metadata and should not be processed by most markdown linting rules.

pub fn skip_mkdocstrings(self) -> Self

Skip lines inside mkdocstrings blocks

Mkdocstrings blocks contain auto-generated documentation and most markdown rules should not process them.

pub fn skip_esm_blocks(self) -> Self

Skip lines inside ESM (ECMAScript Module) blocks

ESM blocks contain JavaScript/TypeScript module code and most markdown rules should not process them.

pub fn skip_math_blocks(self) -> Self

Skip lines inside math blocks ($$ … $$)

Math blocks contain LaTeX/mathematical notation and markdown rules should not process them as regular markdown content.

pub fn skip_quarto_divs(self) -> Self

Skip lines inside Quarto div blocks (::: … :::)

Quarto divs are fenced containers for callouts, panels, and other structured content. Rules may need to skip them for accurate processing.

pub fn skip_jsx_expressions(self) -> Self

Skip lines containing or inside JSX expressions (MDX: {expression})

JSX expressions contain JavaScript code and most markdown rules should not process them as regular markdown content.

pub fn skip_mdx_comments(self) -> Self

Skip lines inside MDX comments ({/* … */})

MDX comments are metadata and should not be processed by most markdown linting rules.

pub fn skip_admonitions(self) -> Self

Skip lines inside MkDocs admonitions (!!! or ???)

Admonitions are callout blocks and may have special formatting that rules should not process as regular content.

pub fn skip_content_tabs(self) -> Self

Skip lines inside MkDocs content tabs (=== “Tab”)

Content tabs contain tabbed content that may need special handling.

pub fn skip_definition_lists(self) -> Self

Skip lines inside definition lists (: definition)

Definition lists have special formatting that rules should not process as regular content.

Trait Implementations

impl Clone for LineFilterConfig

fn clone(&self) -> LineFilterConfig

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for LineFilterConfig

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

Formats the value using the given formatter.

impl Default for LineFilterConfig

fn default() -> LineFilterConfig

Returns the “default value” for a type.