Struct Error 

pub struct Error {
    pub kind: ErrorKind,
    pub path: Vec<Segment>,
    pub location: Option<Box<Location>>,
    pub meta: Option<Box<Meta>>,
}

A validation failure, carrying a breadcrumb path and (when known) the source Location of the offending value.

Display is one line by default; use {error:#} for the location’s caret view.

Fields

kind: ErrorKind

path: Vec<Segment>

Path from the validated root to the offending value (root-first).

location: Option<Box<Location>>

Source location, filled in by the enclosing value that owns it.

Boxed to keep Error small enough to return by value (clippy::result_large_err).

meta: Option<Box<Meta>>

The failing validator’s human-facing metadata (name/description/examples/default).

Boxed for the same size reason as location; filled in by the validator that failed (innermost wins).

Implementations

impl Error

pub fn new(kind: ErrorKind) -> Self

Build a path-less, location-less error for the value currently being validated.

pub fn with_location(self, location: &Location) -> Self

Attach location unless one is already set (the innermost owner wins).

pub fn with_meta(self, meta: &Meta) -> Self

Attach the failing validator’s Meta unless one is already set (innermost wins).

pub fn name(&self) -> Option<&str>

The failing validator’s name, if known.

pub fn default_value(&self) -> Option<&Value>

The failing validator’s default value, if it declared one.

pub fn under_key(self, key: &str, location: &Location) -> Self

Record that this error happened under map key key, whose value lives at location.

pub fn under_index(self, index: usize, location: &Location) -> Self

Record that this error happened under list index index, whose item lives at location.

Trait Implementations

impl Clone for Error

fn clone(&self) -> Error

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

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, f: &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 PartialEq for Error

fn eq(&self, other: &Error) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for Error