Struct HeadingInfo 

pub struct HeadingInfo {

    pub level: u8,
    pub style: HeadingStyle,
    pub marker: String,
    pub marker_column: usize,
    pub content_column: usize,
    pub text: String,
    pub slug_text: String,
    pub custom_id: Option<String>,
    pub raw_text: String,
    pub text_lines: usize,
    pub has_closing_sequence: bool,
    pub closing_sequence: String,
    pub is_valid: bool,
}

Information about a heading

Fields

level: u8

Heading level (1-6 for ATX, 1-2 for Setext)

style: HeadingStyle

Style of heading

marker: String

The heading marker (# characters or underline)

marker_column: usize

Column where the marker starts (0-based)

content_column: usize

Column where heading text starts

text: String

The heading text (without markers and without custom ID syntax)

slug_text: String

The text a slug is generated from: text with every space an anchor element left behind, for the anchor styles that slug it (## Alpha <a id="x"></a> is #alpha- on GitHub, and ## Foo <a id="x"></a> Bar is #foo--bar). See header_id_utils::HeadingText.

custom_id: Option<String>

Custom header ID if present (e.g., from {#custom-id} syntax)

raw_text: String

Original heading text including custom ID syntax. A setext heading’s is the whole paragraph its underline ends, on one line: each soft line break is the space it renders as, and a hard line break’s backslash goes with its line ending.

text_lines: usize

How many source lines hold the heading text: one for an ATX heading, and every line of the paragraph a setext underline makes a heading of. The heading is recorded on the last of them, so the first is text_lines - 1 lines above it.

has_closing_sequence: bool

Whether it has a closing sequence (for ATX)

closing_sequence: String

The closing sequence if present

is_valid: bool

Whether this is a valid CommonMark heading (ATX headings require space after #) False for malformed headings like #NoSpace that MD018 should flag

Trait Implementations

impl Clone for HeadingInfo

fn clone(&self) -> HeadingInfo

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeadingInfo

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

Formats the value using the given formatter.