Struct DocBlock 

pub struct DocBlock {
    pub kind: DocBlockKind,
    pub text: String,
    pub start: usize,
    pub end: usize,
    pub heading_path: Vec<String>,
    pub level: Option<usize>,
}

One parsed span of a document, carrying its byte offsets and the heading path in effect where it appears.

Fields

kind: DocBlockKind

Whether this block is a heading or a paragraph.

text: String

The block’s text: the heading title for headings, the joined paragraph lines for paragraphs.

start: usize

Inclusive start byte offset of the block within the source text.

end: usize

Exclusive end byte offset of the block within the source text.

heading_path: Vec<String>

The chain of enclosing heading titles, outermost first.

level: Option<usize>

The heading depth (1-6) for headings; None for paragraphs.

Trait Implementations

impl Clone for DocBlock

fn clone(&self) -> DocBlock

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DocBlock

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

Formats the value using the given formatter.

impl Eq for DocBlock

impl PartialEq for DocBlock

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DocBlock