Struct Heading 

pub struct Heading {
    pub meta: NodeMeta,
    pub depth: u8,
    pub kind: HeadingKind,
    pub children: Vec<Inline>,
    /* private fields */
}

A heading. Source: # Title (ATX) or Title\n=== (setext).

Fields

meta: NodeMeta

Node metadata (source span).

depth: u8

Heading level, 1..=6.

kind: HeadingKind

Whether the heading used ATX or setext syntax.

children: Vec<Inline>

The heading’s inline content.

Implementations

impl Heading

pub fn new<I, T>(depth: u8, children: I) -> Self

where I: IntoIterator<Item = T>, T: Into<Inline>,

An ATX heading of the given depth.

pub fn with_source( depth: u8, kind: HeadingKind, text: &str, definitions: &Definitions, ) -> (Self, Vec<Diagnostic>)

A heading of the given depth and kind whose content is text, built as Paragraph::with_source builds a paragraph.

pub fn source(&self) -> Option<&str>

The text Heading::with_source built the heading from.

Trait Implementations

impl Clone for Heading

fn clone(&self) -> Self

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 From<Heading> for Block

fn from(node: Heading) -> Self

Converts to this type from the input type.

impl PartialEq for Heading

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Heading