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>,
    },
    UnexpectedEof {
        expected: &'static str,
    },
}

Error produced by the format deserializer.

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.

UnexpectedEof

Unexpected end of input.

Fields

expected: &'static str

What was expected before EOF.

Implementations

impl<E> DeserializeError<E>

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

Create a Reflect error without span or path information.

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

Create a Reflect error with span information.

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

Create a Reflect error with span and path information.

pub const 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> 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.

impl RenderError for DeserializeError<StyxError>

Rendering support for DeserializeError<StyxError>.

This allows rendering the full deserialize error (which may come from the parser or from facet-format’s deserializer) with ariadne diagnostics.

fn render(&self, filename: &str, source: &str) -> String

Render this error with ariadne.

fn write_report<W: Write>(&self, filename: &str, source: &str, writer: W)

Write the error report to a writer.