Struct Heading 

pub struct Heading {
    pub level: u8,
    pub text: String,
    pub id: String,
}

A single heading discovered in a Markdown document.

Returned by collect_headings and by crate::process_markdown_with_toc.

Fields

level: u8

Heading level (1-6 for ATX, 1-2 for setext).

text: String

Plain-text content of the heading (markup stripped).

id: String

The anchor id that comrak emits for this heading. Computed with [comrak::Anchorizer] so it matches the id="…" value produced when MarkdownOptions::header_ids is set.

Trait Implementations

impl Clone for Heading

fn clone(&self) -> Heading

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Heading

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

Formats the value using the given formatter.

impl PartialEq for Heading

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

Tests for self and other values to be equal, and is used by ==.

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Eq for Heading

impl StructuralPartialEq for Heading