Enum Error 

#[non_exhaustive]
pub enum Error {
    Io(Error),
    #[non_exhaustive]
    InvalidPlist {
        format: &'static str,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    #[non_exhaustive]
    Parse {
        format: &'static str,
        source: Option<Box<dyn Error + Send + Sync>>,
    },
    UnknownType(&'static str),
    #[non_exhaustive]
    TypeMismatch {
        expected: &'static str,
        found: &'static str,
    },
    MaxDepthExceeded,
    ParseScalar(String),
    NoRootElement,
    NullNotRepresentable,
    Message(String),
    #[non_exhaustive]
    FeatureDisabled {
        format: Format,
    },
}

Errors returned while encoding or decoding a property list.

The enum and its struct-like variants are #[non_exhaustive], so new variants and fields are not breaking changes.

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.

Io(Error)

An underlying reader or writer failed.

#[non_exhaustive]

InvalidPlist

The input is not recognizable as a property list of format.

This is the only variant that makes the decode ladder fall back from the XML parser to the text parser.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

format: &'static str

The parser that rejected the input: "XML", "binary", or "text".

source: Option<Box<dyn Error + Send + Sync>>

The underlying cause, when one exists.

#[non_exhaustive]

Parse

The input was recognized as format but failed to parse. Never triggers the XML-to-text fallback.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

format: &'static str

The parser that failed: "XML", "binary", or "text".

source: Option<Box<dyn Error + Send + Sync>>

The underlying cause, when one exists.

UnknownType(&'static str)

A value of this type cannot be represented in a property list.

#[non_exhaustive]

TypeMismatch

A property-list value cannot decode into the requested target type.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

expected: &'static str

A description of the requested target type.

found: &'static str

The property-list type name that was found.

MaxDepthExceeded

Nesting exceeded MAX_PARSE_DEPTH while parsing — the input is too deeply nested to process safely.

ParseScalar(String)

A scalar literal failed to parse (integer, real, boolean, or date).

NoRootElement

Encoding produced no root element to write.

NullNotRepresentable

A null value reached a position where property lists cannot express it.

Message(String)

A free-form message, used by serde Error::custom and similar.

#[non_exhaustive]

FeatureDisabled

The requested output format is behind a cargo feature that is not enabled in this build.

Fields

Non-exhaustive enum variants could have additional fields added in future. Therefore, non-exhaustive enum variants cannot be constructed in external crates and cannot be matched against.

format: Format

The format whose codec is compiled out.

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, __formatter: &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

Available on crate feature serde only.

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

Used when a Serialize implementation encounters any error while serializing a type.

impl Error for Error

Available on crate feature serde only.

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 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 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 duplicate_field(field: &'static str) -> Self

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

impl From<Error> for Error

fn from(source: Error) -> Self

Converts to this type from the input type.