Struct pulldown_cmark_toc::TableOfContents

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

Represents a Table of Contents.

Implementations

impl<'a> TableOfContents<'a>

pub fn new(text: &'a str) -> Self

Construct a new table of contents from Markdown text.

Examples

let toc = TableOfContents::new("# Heading\n");

pub fn new_with_events<I, E>(events: I) -> Self

where I: Iterator<Item = E>, E: Borrow<Event<'a>>,

Construct a new table of contents from parsed Markdown events.

Examples

use pulldown_cmark::Parser;

let parser = Parser::new("# Heading\n");
let toc = TableOfContents::new_with_events(parser);;

pub fn headings(&self) -> Iter<'_, Heading<'_>>

Iterate over the headings in this table of contents.

Examples

Simple iteration over each heading.

let toc = TableOfContents::new("# Heading\n");

for heading in toc.headings() {
    // use heading
}

Filtering out certain heading levels.

let toc = TableOfContents::new("# Heading\n## Subheading\n");

for heading in toc.headings().filter(|h| h.level() >= HeadingLevel::H2) {
    // use heading
}

pub fn to_cmark(&self) -> String

Render the table of contents as Markdown.

Examples

let toc = TableOfContents::new("# Heading\n## Subheading\n");
assert_eq!(
    toc.to_cmark(),
    "- [Heading](#heading)\n  - [Subheading](#subheading)\n"
);

pub fn to_cmark_with_options(&self, options: Options) -> String

Render the table of contents as Markdown with extra options.

Examples

let toc = TableOfContents::new("# Heading\n## Subheading\n");
let options = Options::default()
    .item_symbol(ItemSymbol::Asterisk)
    .levels(HeadingLevel::H2..=HeadingLevel::H6)
    .indent(4);
assert_eq!(
    toc.to_cmark_with_options(options),
    "* [Subheading](#subheading)\n"
);

Trait Implementations

impl<'a> Debug for TableOfContents<'a>

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

Formats the value using the given formatter.