Enum DeserializeError 

pub enum DeserializeError<E> {
    Parser(E),
    Reflect {
        error: ReflectError,
        span: Option<Span>,
        path: Option<Path>,
    },
    TypeMismatch {
        expected: &'static str,
        got: String,
        span: Option<Span>,
        path: Option<Path>,
    },
    Unsupported(String),
    UnknownField {
        field: String,
        span: Option<Span>,
        path: Option<Path>,
    },
    CannotBorrow {
        message: String,
    },
    MissingField {
        field: &'static str,
        type_name: &'static str,
        span: Option<Span>,
        path: Option<Path>,
    },
    ExpectedScalarGotStruct {
        expected_shape: &'static Shape,
        got_container: ContainerKind,
        span: Option<Span>,
        path: Option<Path>,
    },
    UnexpectedEof {
        expected: &'static str,
    },
}

Error produced by FormatDeserializer.

Variants

Parser(E)

Error emitted by the format-specific parser.

Reflect

Reflection error from Partial operations.

Fields

error: ReflectError

The underlying reflection error.

span: Option<Span>

Source span where the error occurred (if available).

path: Option<Path>

Path through the type structure where the error occurred.

TypeMismatch

Type mismatch during deserialization.

Fields

expected: &'static str

The expected type or token.

got: String

The actual type or token that was encountered.

span: Option<Span>

Source span where the mismatch occurred (if available).

path: Option<Path>

Path through the type structure where the error occurred.

Unsupported(String)

Unsupported type or operation.

UnknownField

Unknown field encountered when deny_unknown_fields is set.

Fields

field: String

The unknown field name.

span: Option<Span>

Source span where the unknown field was found (if available).

path: Option<Path>

Path through the type structure where the error occurred.

CannotBorrow

Cannot borrow string from input (e.g., escaped string into &str).

Fields

message: String

Description of why borrowing failed.

MissingField

Required field missing from input.

Fields

field: &'static str

The field that is missing.

type_name: &'static str

The type that contains the field.

span: Option<Span>

Source span where the struct was being parsed (if available).

path: Option<Path>

Path through the type structure where the error occurred.

ExpectedScalarGotStruct

Expected a scalar value but got a struct/object.

This typically happens when a format-specific mapping expects a scalar (like a KDL property name=value) but receives a child node instead (like KDL node with arguments name "value").

Fields

expected_shape: &'static Shape

The shape that was expected (provides access to type info and attributes).

got_container: ContainerKind

The container kind that was received (Object, Array, Element).

span: Option<Span>

Source span where the mismatch occurred (if available).

path: Option<Path>

Path through the type structure where the error occurred.

UnexpectedEof

Unexpected end of input.

Fields

expected: &'static str

What was expected before EOF.

Implementations

impl<E> DeserializeError<E>

pub fn reflect(error: ReflectError) -> DeserializeError<E>

Create a Reflect error without span or path information.

pub fn reflect_with_span(error: ReflectError, span: Span) -> DeserializeError<E>

Create a Reflect error with span information.

pub fn reflect_with_context( error: ReflectError, span: Option<Span>, path: Path, ) -> DeserializeError<E>

Create a Reflect error with span and path information.

pub fn path(&self) -> Option<&Path>

Get the path where the error occurred, if available.

pub fn with_path(self, new_path: Path) -> DeserializeError<E>

Add path information to an error (consumes and returns the modified error).

Trait Implementations

impl<E> Debug for DeserializeError<E>

where E: Debug,

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

Formats the value using the given formatter.

impl<E> Diagnostic for DeserializeError<E>

where E: Diagnostic + 'static,

Available on crate feature miette only.

fn code<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Unique diagnostic code that can be used to look up more information about this Diagnostic. Ideally also globally unique, and documented in the toplevel crate’s documentation for easy searching. Rust path format (foo::bar::baz) is recommended, but more classic codes like E0123 or enums will work just fine.

fn severity(&self) -> Option<Severity>

Diagnostic severity. This may be used by ReportHandlers to change the display format of this diagnostic.

fn help<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

Additional help text related to this Diagnostic. Do you have any advice for the poor soul who’s just run into this issue?

fn url<'a>(&'a self) -> Option<Box<dyn Display + 'a>>

URL to visit for a more detailed explanation/help about this Diagnostic.

fn source_code(&self) -> Option<&dyn SourceCode>

Source code to apply this Diagnostic’s Diagnostic::labels to.

fn labels(&self) -> Option<Box<dyn Iterator<Item = LabeledSpan> + '_>>

Labels to apply to this Diagnostic’s Diagnostic::source_code

fn related<'a>( &'a self, ) -> Option<Box<dyn Iterator<Item = &'a dyn Diagnostic> + 'a>>

Additional related Diagnostics.

fn diagnostic_source(&self) -> Option<&dyn Diagnostic>

The cause of the error.

impl<E> Display for DeserializeError<E>

where E: Display,

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

Formats the value using the given formatter.

impl<E> Error for DeserializeError<E>

where E: Debug + Display,

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.