Enum ParseError 

#[non_exhaustive]
pub enum ParseError {
    InputTooLarge {
        size: usize,
        max: usize,
    },
    InvalidStructure(String),
    EmptyInput(String),
    MissingQuill(String),
    InvalidQuillReference {
        value: String,
        reason: String,
    },
    BodyImport(String),
    YamlErrorWithLocation {
        message: String,
        line: usize,
        block_index: usize,
        hint: Option<String>,
    },
}

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

InputTooLarge

Fields

size: usize

max: usize

InvalidStructure(String)

EmptyInput(String)

Markdown input was empty or whitespace-only.

Emitted as code parse::empty_input so consumers can pattern-match without inspecting the message text.

MissingQuill(String)

The document is missing its root ~~~ card-yaml block, or that block does not declare the required $quill system metadata.

Emitted as code parse::missing_quill so consumers can pattern-match without inspecting the message text.

InvalidQuillReference

A $quill reference failed to parse as a crate::version::QuillReference. Code parse::invalid_quill_reference; carries crate::version::quill_ref_hint as its diagnostic hint.

Fields

value: String

reason: String

The from_str violation.

BodyImport(String)

A card body’s markdown could not be imported into the content model: today only when container nesting exceeds MAX_NESTING_DEPTH. Code parse::body_import.

YamlErrorWithLocation

Fields

message: String

line: usize

Line number in the source document (1-indexed)

block_index: usize

Index of the metadata block (0-indexed)

hint: Option<String>

Optional actionable hint attached when the YAML parser’s message is too cryptic to be recoverable on its own. Derived by the internal document::yaml_hints enrichment pass.

Implementations

impl ParseError

pub fn args(&self) -> BTreeMap<String, Value>

The facts this error’s message interpolates. See Diagnostic::args.

The four String variants contribute no keys, for two different reasons canon distinguishes: EmptyInput is one fixed sentence, while InvalidStructure, BodyImport, and MissingQuill carry prose minted per-site. MissingQuill looks fixed and is not: it picks one of three sentences by re-reading the source, and no field records which.

pub fn to_diagnostic(&self) -> Diagnostic

Trait Implementations

impl Debug for ParseError

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

Formats the value using the given formatter.

impl Display for ParseError

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

Formats the value using the given formatter.

impl Error for ParseError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<ParseError> for RenderError

fn from(err: ParseError) -> Self

Converts to this type from the input type.

impl From<ParseError> for BoundParseError

fn from(source: ParseError) -> Self

Converts to this type from the input type.