Struct Headings 

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

Headings extracted from a Markdown document.

This helper is useful for building a table of contents. It walks the tree in document order, converts each heading to plain text, and assigns unique anchors to repeated headings. Anchor assignment includes headings filtered out by HeadingOptions, so the remaining anchors still match rendered headings when CompileOptions::heading_ids is enabled.

Implementations

impl<'a> Headings<'a>

pub fn extract(root: &'a Node) -> Self

Extract all headings from a document tree.

pub fn extract_with_options(root: &'a Node, options: &HeadingOptions) -> Self

Extract headings from a document tree with a level range.

pub fn as_slice(&self) -> &[HeadingEntry<'a>]

Return the extracted entries as a slice.

pub fn iter(&self) -> Iter<'_, HeadingEntry<'a>>

Iterate over the extracted entries in document order.

pub fn len(&self) -> usize

Return the number of extracted headings.

pub fn is_empty(&self) -> bool

Whether the document contains no headings in the selected level range.

Trait Implementations

impl<'a> Clone for Headings<'a>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<'a> Debug for Headings<'a>

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

Formats the value using the given formatter.

impl<'a> Default for Headings<'a>

fn default() -> Self

Returns the “default value” for a type.

impl<'a> Eq for Headings<'a>

impl<'a, 'b> IntoIterator for &'b Headings<'a>

type Item = &'b HeadingEntry<'a>

The type of the elements being iterated over.

type IntoIter = Iter<'b, HeadingEntry<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> IntoIterator for Headings<'a>

type Item = HeadingEntry<'a>

The type of the elements being iterated over.

type IntoIter = IntoIter<HeadingEntry<'a>>

Which kind of iterator are we turning this into?

fn into_iter(self) -> Self::IntoIter

Creates an iterator from a value.

impl<'a> PartialEq for Headings<'a>

fn eq(&self, other: &Self) -> bool

Equality operator ==.

fn ne(&self, other: &Rhs) -> bool

Inequality operator !=.

impl<'a> StructuralPartialEq for Headings<'a>