Struct serde_yaml::Error

pub struct Error(_);

This type represents all possible errors that can occur when serializing or deserializing YAML data.

Methods

impl Error

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

Returns the Location from the error if one exists.

Not all types of errors have a location so this can return None.

Examples

// The `@` character as the first character makes this invalid yaml
let invalid_yaml: Result<Value, Error> = serde_yaml::from_str("@invalid_yaml");

let location = invalid_yaml.unwrap_err().location().unwrap();

assert_eq!(location.line(), 1);
assert_eq!(location.column(), 1);

Trait Implementations

impl Display for Error

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

Formats the value using the given formatter.

impl Debug for Error

fn fmt(&self, formatter: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Error for Error

fn description(&self) -> &str

This method is soft-deprecated.

fn cause(&self) -> Option<&dyn Error>

Deprecating in 1.33.0

: replaced by Error::source, which can support downcasting

The lower-level cause of this error, if any.

fn source(&self) -> Option<&(dyn Error + 'static)>

The lower-level source of this error, if any.

impl Error for Error

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

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

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