Struct FilteredLinesBuilder 

pub struct FilteredLinesBuilder<'a> { /* private fields */ }

Builder type that allows chaining filter configuration and converting to an iterator

Implementations

impl<'a> FilteredLinesBuilder<'a>

pub fn skip_front_matter(self) -> Self

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

pub fn skip_code_blocks(self) -> Self

Skip lines inside fenced code blocks

pub fn skip_html_blocks(self) -> Self

Skip lines inside HTML blocks

pub fn skip_html_comments(self) -> Self

Skip lines inside HTML comments

pub fn skip_mkdocstrings(self) -> Self

Skip lines inside mkdocstrings blocks

pub fn skip_esm_blocks(self) -> Self

Skip lines inside ESM (ECMAScript Module) blocks

pub fn skip_math_blocks(self) -> Self

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

pub fn skip_quarto_divs(self) -> Self

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

pub fn skip_jsx_expressions(self) -> Self

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

pub fn skip_mdx_comments(self) -> Self

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

pub fn skip_admonitions(self) -> Self

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

pub fn skip_content_tabs(self) -> Self

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

pub fn skip_mkdocs_html_markdown(self) -> Self

Skip lines inside HTML blocks with markdown attribute (MkDocs grid cards, etc.)

pub fn skip_mkdocs_containers(self) -> Self

Skip lines inside any MkDocs container (admonitions, content tabs, or markdown HTML divs)

This is a convenience method that enables skip_admonitions, skip_content_tabs, and skip_mkdocs_html_markdown. MkDocs containers use 4-space indented content which may need special handling to preserve structure.

pub fn skip_definition_lists(self) -> Self

Skip lines inside definition lists (: definition)

pub fn skip_obsidian_comments(self) -> Self

Skip lines inside Obsidian comments (%%…%%)

pub fn skip_pymdown_blocks(self) -> Self

Skip lines inside PyMdown Blocks (/// … ///)

pub fn skip_div_markers(self) -> Self

Skip lines that are div markers (::: opening or closing)

Unlike skip_quarto_divs which skips ALL lines inside a div block, this only skips the ::: marker lines themselves.

pub fn skip_jsx_blocks(self) -> Self

Skip lines inside JSX component blocks (MDX only)

Trait Implementations

impl<'a> IntoIterator for FilteredLinesBuilder<'a>

type Item = FilteredLine<'a>

The type of the elements being iterated over.

type IntoIter = FilteredLinesIter<'a>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.