Enum DiagnosticTarget 

pub enum DiagnosticTarget {
    Header(HeaderPath),
    MissingHeader {
        parent: HeaderPath,
        matcher: String,
    },
    Document,
    Frontmatter {
        block: Option<FrontmatterBlock>,
    },
}

What a diagnostic is about.

The four cases carry text of different provenance, and conflating them in one HeaderPath silently mixes document text with schema text. Only Self::Header names text that occurs in the document; the matcher label in Self::MissingHeader comes from the schema and may occur nowhere in the document; Self::Document and Self::Frontmatter name no header at all.

Variants

Header(HeaderPath)

A header that exists in the document, named by its document path.

MissingHeader

A section the schema requires but the document does not contain.

Fields

parent: HeaderPath

Document path of the header whose scope should have contained it.

Empty when no header encloses the missing section: it belongs to the document root’s scope (including a missing h1 title), or the sugar’s single-h1 voice reports its sections scope as the document’s.

matcher: String

Label of the unsatisfied schema matcher: exact text, a glob, a slash-delimited regex, or *. This is schema text, not a heading.

Document

The document as a whole, when no single header can name the violation.

Used for the document root’s scope, which has no parent header, and for the sugar’s single-h1 document voice described by specification §6.2.

Frontmatter

A frontmatter block, or a value inside one. Has no header path.

Fields

block: Option<FrontmatterBlock>

The offending block, absent only when the document has none.

Trait Implementations

impl Clone for DiagnosticTarget

fn clone(&self) -> DiagnosticTarget

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for DiagnosticTarget

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

Formats the value using the given formatter.

impl Eq for DiagnosticTarget

impl PartialEq for DiagnosticTarget

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for DiagnosticTarget