Enum ValidationError 

pub enum ValidationError {
    TypeMismatch {
        path: String,
        expected: String,
        actual: String,
        source_token: String,
        default: Option<String>,
    },
    EnumViolation {
        path: String,
        value: String,
        allowed: Vec<String>,
    },
    FormatViolation {
        path: String,
        format: String,
    },
    UnknownCard {
        path: String,
        card: String,
    },
    BodyDisabled {
        path: String,
        card: String,
    },
    NotInline {
        path: String,
    },
    NotPlain {
        path: String,
    },
}

Validation error with a structured field path.

Field-level type and presence errors carry the field path, the schema-declared type, and any verbatim YAML source token / default — enough for the Display impl to render the uniform diagnostic message described in ERROR.md (“Validation message contract”).

Two concerns are deliberately not well-formedness errors and so have no variant here: the !must_fill marker (surfaced as a non-fatal warning by Quill::validate) and field absence (an absent or present-null field zero-fills at render). Both are handled outside the value-layer checks below.

Variants

TypeMismatch

Fields

path: String

expected: String

Schema-declared type (string, integer, …).

actual: String

YAML-parsed type of the source token (integer, number, boolean, null, string, array, object).

source_token: String

Verbatim YAML scalar that triggered the error, rendered in its canonical YAML form (42, null, "hello", "").

default: Option<String>

Pre-rendered default token from the schema, when present. Same canonical YAML form as source_token.

EnumViolation

Fields

path: String

value: String

allowed: Vec<String>

FormatViolation

Fields

path: String

format: String

UnknownCard

Fields

path: String

card: String

BodyDisabled

Fields

path: String

card: String

NotInline

A richtext(inline) field whose content is not single-Para (a block, a list/quote container, or an island). Same fatality class as TypeMismatch — the value is well-typed richtext but the wrong shape for an inline field.

Fields

path: String

NotPlain

A plaintext field whose content carries marks, islands, or block formatting. Same fatality class as TypeMismatch — the value is a well-formed content but the wrong shape for a plaintext field, which takes prose the author navigates but no formatting.

Fields

path: String

Implementations

impl ValidationError

pub fn path(&self) -> &str

Document-model path anchor for this error.

See crate::error module docs for the path grammar and conventions.

pub fn code(&self) -> &'static str

Stable diagnostic code for this error variant. Pattern-match on this instead of the message text.

pub fn hint(&self) -> Option<String>

Actionable hint for this error, when defined for the variant — the same string the Display impl bakes in, exposed so consumers can surface it without re-parsing prose.

pub fn to_diagnostic(&self) -> Diagnostic

Convert this error into a structured Diagnostic carrying the stable code, the document-model path, the canonical message, and the actionable hint (when the variant defines one).

Trait Implementations

impl Clone for ValidationError

fn clone(&self) -> ValidationError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ValidationError

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

Formats the value using the given formatter.

impl Display for ValidationError

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

Formats the value using the given formatter.

impl Eq for ValidationError

impl Error for ValidationError

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 PartialEq for ValidationError

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for ValidationError