Struct HeadingComment

pub struct HeadingComment {
    pub header: Span,
    pub content: Span,
}

A parsed heading comment.

Fields

header: Span

The header part of the heading comment (the text of the header)

content: Span

The content part of the heading comment (descriptive text regarding the header)

Implementations

impl HeadingComment

pub fn parse(buf: &[u8], lvl: HeadingLevel, sp: Span) -> Option<Self>

Parses a heading comment at the given span in a segment buffer, with the specified heading level and span. Returns None if this is not a heading comment or it is malformed.

pub fn parse_mathbox_header(&self, buf: &[u8]) -> Option<Span>

Parses a mathbox heading comment, returning the span of the author name.

Trait Implementations

impl Clone for HeadingComment

fn clone(&self) -> HeadingComment

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HeadingComment

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

Formats the value using the given formatter.

impl Copy for HeadingComment