Struct ParsedHeading 

pub struct ParsedHeading<'a> {
    pub line_num: usize,
    pub heading: &'a HeadingInfo,
    pub line_info: &'a LineInfo,
    pub text_line_infos: &'a [LineInfo],
    pub blockquote_depth: usize,
}

A heading recognized in the rendered Markdown document.

Unlike ValidHeading, this view includes headings inside blockquotes and malformed ATX headings retained for diagnostics such as MD018. Consumers can select the semantics they need without reparsing source lines.

Fields

line_num: usize

The 1-indexed number of the line the heading is recorded on: the ATX line, or the last text line of a setext heading, whose underline is the line after it.

heading: &'a HeadingInfo

Parsed heading metadata.

line_info: &'a LineInfo

Full source-line metadata of the line the heading is recorded on.

text_line_infos: &'a [LineInfo]

Metadata of every line holding the heading text, first to last: line_info alone, unless the heading is a setext heading whose paragraph spans lines.

blockquote_depth: usize

Blockquote nesting depth, or zero for a top-level heading.

Implementations

impl<'a> ParsedHeading<'a>

pub fn is_blockquote(&self) -> bool

Whether this heading is inside a blockquote.

pub fn is_setext(&self) -> bool

Whether this is a Setext-style heading.

pub fn first_line_num(&self) -> usize

The 1-indexed number of the first line holding the heading text.

pub fn first_line_info(&self) -> &'a LineInfo

Metadata of the first line holding the heading text.

pub fn text_byte_range(&self, source: &str) -> Range<usize>

Byte range of the heading text in the document.

Markers, closing ATX sequences and custom-ID syntax are excluded. The text of a setext heading is the whole paragraph its underline ends, so the range runs from the text on the paragraph’s first line to the text on its last, across the line breaks and container prefixes between them.

pub fn text_position_range( &self, ctx: &LintContext<'_>, ) -> (usize, usize, usize, usize)

Position of the heading text as (line, column, end_line, end_column), 1-indexed with character columns and an exclusive end.

A warning about a heading spans this range, which covers every text line of a setext heading whose paragraph spans more than one.

Trait Implementations

impl<'a> Clone for ParsedHeading<'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> Copy for ParsedHeading<'a>

impl<'a> Debug for ParsedHeading<'a>

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

Formats the value using the given formatter.