Struct serde_yaml::Error

pub struct Error(_);

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

Implementations

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

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

pub fn description(&self) -> &str

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

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

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

pub fn backtrace(&self) -> Option<&Backtrace>

🔬 This is a nightly-only experimental API. (backtrace)

Returns a stack backtrace, if available, of where this error occurred.

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

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

impl Error for Error

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

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

impl Error for Error

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

Raised when there is general error when deserializing a type.

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

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

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

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

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

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

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

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

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

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

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