Struct Error

Source

pub struct Error { /* private fields */ }

Available on crate feature openapi only.

Expand description

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

Implementations§

Source §

impl Error

Source

pub fn line(&self) -> usize

Available on native and crate feature serde only.

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.

Source

pub fn column(&self) -> usize

Available on native and crate feature serde only.

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 I/O stream fails immediately following a previously read newline character.

Source

pub fn classify(&self) -> Category

Available on native and crate feature serde only.

Categorizes the cause of this error.

Category::Io - failure to read or write bytes on an I/O 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

Source

pub fn is_io(&self) -> bool

Available on native and crate feature serde only.

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

Source

pub fn is_syntax(&self) -> bool

Available on native and crate feature serde only.

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

Source

pub fn is_data(&self) -> bool

Available on native and crate feature serde only.

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.

Source

pub fn is_eof(&self) -> bool

Available on native and crate feature serde only.

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.

Source

pub fn io_error_kind(&self) -> Option<ErrorKind>

Available on native and crate feature serde and crate feature std only.

The kind reported by the underlying standard library I/O error, if this error was caused by a failure to read or write bytes on an I/O stream.

§Example

use serde_json::Value;
use std::io::{self, ErrorKind, Read};
use std::process;

struct ReaderThatWillTimeOut<'a>(&'a [u8]);

impl<'a> Read for ReaderThatWillTimeOut<'a> {
    fn read(&mut self, buf: &mut [u8]) -> io::Result<usize> {
        if self.0.is_empty() {
            Err(io::Error::new(ErrorKind::TimedOut, "timed out"))
        } else {
            self.0.read(buf)
        }
    }
}

fn main() {
    let reader = ReaderThatWillTimeOut(br#" {"k": "#);

    let _: Value = match serde_json::from_reader(reader) {
        Ok(value) => value,
        Err(error) => {
            if error.io_error_kind() == Some(ErrorKind::TimedOut) {
                // Maybe this application needs to retry certain kinds of errors.

            } else {
                eprintln!("error: {}", error);
                process::exit(1);
            }
        }
    };
}

Trait Implementations§

Source §

impl Debug for Error

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Display for Error

Source §

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

Formats the value using the given formatter. Read more

Source §

impl Error for Error

Source §

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

Returns the lower-level source of this error, if any. Read more

1.0.0 · Source§

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

Source §

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

Source §

impl Error for Error

Source §

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

Raised when there is general error when deserializing a type. Read more

Source §

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

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

Source §

fn invalid_value(unexp: Unexpected<'_>, exp: &dyn Expected) -> Error

Raised when a Deserialize receives a value of the right type but that is wrong for some other reason. Read more

Source §

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

Source §

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

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

Source §

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

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

Source §

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.

Source §

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

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

Source §

impl Error for Error

Source §

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

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

Source §