Struct serde_json::error::Error

pub struct Error { /* fields omitted */ }

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

Methods

impl Error

fn line(&self) -> usize

One-based line number at which the error was detected.

Characters in the first line of the input (before the first newline character) are in line 1.

fn column(&self) -> usize

One-based column number at which the error was detected.

The first character in the input and any characters immediately following a newline character are in column 1.

Note that errors may occur in column 0, for example if a read from an IO stream fails immediately following a previously read newline character.

fn classify(&self) -> Category

Categorizes the cause of this error.

• Category::Io - failure to read or write bytes on an IO stream
• Category::Syntax - input that is not syntactically valid JSON
• Category::Data - input data that is semantically incorrect
• Category::Eof - unexpected end of the input data

fn is_io(&self) -> bool

Returns true if this error was caused by a failure to read or write bytes on an IO stream.

fn is_syntax(&self) -> bool

Returns true if this error was caused by input that was not syntactically valid JSON.

fn is_data(&self) -> bool

Returns true if this error was caused by input data that was semantically incorrect.

For example, JSON containing a number is semantically incorrect when the type being deserialized into holds a String.

fn is_eof(&self) -> bool

Returns true if this error was caused by prematurely reaching the end of the input data.

Callers that process streaming input may be interested in retrying the deserialization once more data is available.

Trait Implementations

impl Error for Error

fn description(&self) -> &str

A short description of the error.

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

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

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, f: &mut Formatter) -> Result

Formats the value using the given formatter.

impl Error for Error

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

Raised when there is general error when deserializing a type.

fn invalid_type(unexp: Unexpected, exp: &Expected) -> Self

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

fn invalid_value(unexp: Unexpected, exp: &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: &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 Error for Error

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

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