Enum Error 

#[non_exhaustive]
pub enum Error {
    Message {
        msg: String,
        location: Location,
    },
    Eof {
        location: Location,
    },
    Unexpected {
        expected: &'static str,
        location: Location,
    },
    ContainerEndMismatch {
        location: Location,
    },
    UnknownAnchor {
        id: usize,
        location: Location,
    },
    AliasError {
        msg: String,
        locations: Locations,
    },
    HookError {
        msg: String,
        location: Location,
    },
    Budget {
        breach: BudgetBreach,
        location: Location,
    },
    IOError {
        cause: Error,
    },
    QuotingRequired {
        value: String,
        location: Location,
    },
    CannotBorrowTransformedString {
        reason: TransformReason,
        location: Location,
    },
    WithSnippet {
        text: String,
        crop_radius: usize,
        error: Box<Error>,
    },
    ValidationError {
        report: Report,
        locations: PathMap,
    },
    ValidationErrors {
        errors: Vec<Error>,
    },
    ValidatorError {
        errors: ValidationErrors,
        locations: PathMap,
    },
    ValidatorErrors {
        errors: Vec<Error>,
    },
}

Error type compatible with serde::de::Error.

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.

Message

Free-form error with optional source location.

Fields

msg: String

location: Location

Eof

Unexpected end of input.

Fields

location: Location

Unexpected

Structural/type mismatch — something else than the expected token/value was seen.

Fields

expected: &'static str

location: Location

ContainerEndMismatch

Fields

location: Location

UnknownAnchor

Alias references a non-existent anchor id.

Fields

id: usize

location: Location

AliasError

Error related to an alias, with both reference (use-site) and defined (anchor) locations.

This variant allows reporting both where an alias is used and where the anchor is defined, which is useful for errors that occur when deserializing aliased values.

Fields

msg: String

locations: Locations

HookError

Error when parsing robotic and other extensions beyond standard YAML. (error in extension hook).

Fields

msg: String

location: Location

Budget

A YAML budget limit was exceeded.

Fields

breach: BudgetBreach

location: Location

IOError

Unexpected I/O error. This may happen only when deserializing from a reader.

Fields

cause: Error

QuotingRequired

The value is targeted to the string field but can be interpreted as a number or boolean. This error can only happen if no_schema set true.

Fields

value: String

location: Location

CannotBorrowTransformedString

The target type requires a borrowed string (&str), but the value was transformed during parsing (e.g., through escape processing, line folding, or multi-line normalization) and cannot be borrowed from the input.

Use String or Cow<str> instead of &str to handle transformed values.

Fields

reason: TransformReason

The reason why the string had to be transformed and cannot be borrowed.

location: Location

WithSnippet

Wrap an error with the full input text, enabling rustc-like snippet rendering.

Fields

text: String

Pre-rendered snippet output (cropped) for display.

Note: this intentionally does NOT store the full input text, to avoid retaining large YAML inputs inside errors.

crop_radius: usize

error: Box<Error>

ValidationError

Garde validation failure.

Fields

report: Report

locations: PathMap

ValidationErrors

Garde validation failures (multiple, if multiple validations fail)

Fields

errors: Vec<Error>

ValidatorError

Validator validation failure.

Fields

errors: ValidationErrors

locations: PathMap

ValidatorErrors

Validator validation failures (multiple, if multiple validations fail)

Fields

errors: Vec<Error>

Implementations

impl Error

pub fn without_snippet(&self) -> &Self

Provide “no snippet” version for cases when snippet rendering is not desired.

pub fn cannot_borrow_transformed(reason: TransformReason) -> Self

Construct a CannotBorrowTransformedString error for the given reason.

This error is returned when deserializing to &str but the string value was transformed during parsing and cannot be borrowed from the input.

pub fn location(&self) -> Option<Location>

If the error has a known location, return it.

Returns:

• Some(Location) when coordinates are known; None otherwise.

Used by:

• Callers that want to surface precise positions to users.

pub fn locations(&self) -> Option<Locations>

Return a pair of locations associated with this error.

• For syntax and other errors that carry a single Location, this returns two identical locations.

• For validation errors (when the garde / validator feature is enabled), this returns the (reference_location, defined_location) pair for the first validation entry.

  These two locations may differ when YAML anchors/aliases are involved.

• Returns None when no meaningful location information is available.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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 Error for Error

fn custom<T: Display>(msg: T) -> Self

Raised when there is general error when deserializing a type.

fn invalid_type(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a type different from what it was expecting.

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Self

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason.

fn unknown_variant(variant: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize enum type received a variant with an unrecognized name.

fn unknown_field(field: &str, expected: &'static [&'static str]) -> Self

Raised when a Deserialize struct type received a field with an unrecognized name.

fn missing_field(field: &'static str) -> Self

Raised when a Deserialize struct type expected to receive a required field with a particular name but that field was not present in the input.

fn invalid_length(len: usize, exp: &dyn Expected) -> Self

Raised when deserializing a sequence or map and the input data contains too many or too few elements.

fn duplicate_field(field: &'static str) -> Self

Raised when a Deserialize struct type received more than one of the same field.