Struct Heading 

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

One heading found by parsing a document, with the byte offset at which it begins.

See headings for why the offset is the useful part.

Fields

level: u8

Heading level: 1 for #, 2 for ##, and so on.

id: String

The id this heading gets, which is the id it can be linked by.

heading_id_from answers what it claims — its explicit {#id} when the author wrote one, the slug of its text otherwise. This is that answer after the two questions only the document can settle: an unnameable heading falls back to its position, and a claim an earlier heading already took is suffixed. See headings.

text: String

The heading’s visible text, with the markup that produced it removed.

start: usize

Byte offset into the source where this heading begins.

The heading’s own start, not its container’s: for > ## Quoted it points at the #, past the blockquote marker. Callers use it to decide which heading a later byte falls under, which is a comparison rather than a slice, so what precedes it on the line does not concern them.

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 Eq for Heading

impl PartialEq for Heading

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Heading