Skip to main content

ValidationError

Struct ValidationError 

Source
pub struct ValidationError {
    pub path: Vec<PathSegment>,
    pub code: String,
    pub message: String,
    pub params: HashMap<String, Value>,
}
Expand description

A single validation error with location context.

Each error includes the path to the invalid field (supporting nested structs and collection indices), a machine-readable error code, a human-readable message, and optional constraint parameters for structured error reporting.

§Example

use rusdantic_core::{ValidationError, PathSegment};

let error = ValidationError {
    path: vec![
        PathSegment::Field("user".to_string()),
        PathSegment::Field("email".to_string()),
    ],
    code: "email".to_string(),
    message: "invalid email format".to_string(),
    params: Default::default(),
};

assert_eq!(error.path_string(), "user.email");

Fields§

§path: Vec<PathSegment>

Path to the invalid field.

For nested structs, this contains multiple segments: ["user", "addresses", 0, "zip_code"]

§code: String

Machine-readable error code.

Standard codes include: "length_min", "length_max", "range_min", "range_max", "email", "url", "pattern", "contains", "required", "custom".

§message: String

Human-readable error message suitable for display to end users.

§params: HashMap<String, Value>

Constraint parameters providing context about the validation failure.

For example, a length violation might include: {"min": 3, "max": 20, "actual": 1}

Implementations§

Source§

impl ValidationError

Source

pub fn new(code: impl Into<String>, message: impl Into<String>) -> Self

Create a new validation error with the given code and message.

Source

pub fn with_param(self, key: impl Into<String>, value: impl Into<Value>) -> Self

Add a parameter to this error for structured error reporting.

Source

pub fn with_path(self, path: Vec<PathSegment>) -> Self

Set the path for this error.

Source

pub fn path_string(&self) -> String

Format the path as a dot-notation string.

Field segments are joined with ., index segments are formatted as [N]. Example: "user.addresses[0].zip_code"

Trait Implementations§

Source§

impl Clone for ValidationError

Source§

fn clone(&self) -> ValidationError

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ValidationError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Display for ValidationError

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Error for ValidationError

1.30.0 · 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()

1.0.0 · Source§

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 PartialEq for ValidationError

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 · Source§

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

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

impl Serialize for ValidationError

Source§

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>
where __S: Serializer,

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ValidationError

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> Dump for T
where T: Serialize,

Source§

fn dump(&self) -> Result<Value, Error>

Serialize to a serde_json::Value with default options.
Source§

fn dump_with(&self, options: &DumpOptions) -> Result<Value, Error>

Serialize to a serde_json::Value with custom options.
Source§

fn dump_json(&self) -> Result<String, Error>

Serialize to a JSON string with default options.
Source§

fn dump_json_with(&self, options: &DumpOptions) -> Result<String, Error>

Serialize to a JSON string with custom options.
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.