Struct valid::ValidationError

pub struct ValidationError {
    pub message: Option<Cow<'static, str>>,
    pub violations: Vec<ConstraintViolation>,
}

The error type returned if the validation finds any constraint violation.

It holds a list of constraint violations and an optional message. The message is meant to describe the context in which the validation has been performed. It is helpful when validating a struct that represents an input form or a REST command. In such cases the message would be something like "validating registration form" or "invalid post entry command".

The Display and Error traits are implemented to be compatible with most error management concepts. It can be converted into failure::Error using From or Into conversion traits.

It can be serialized and deserialized using the serde crate. To enable serde support the optional crate feature serde1 must be enabled.

Fields

message: Option<Cow<'static, str>>

Message that describes the context in which the validation has been executed

violations: Vec<ConstraintViolation>

A list of constraint violations found during validation

Methods

impl ValidationError

pub fn merge(self, other: ValidationError) -> Self

Merges this validation error with another validation error and returns a new validation error that contains all constraint violations from both errors merged into one list.

If both of the validation errors contain a message than the messages are concatenated separated by the string ' / '. If only one of the two errors contain a message than this message becomes the message of the resulting error.

Examples

use valid::{ValidationError, invalid_value};

let validation_error1 = ValidationError {
    message: Some("validating a user's age".into()),
    violations: vec![invalid_value("invalid-bound-min", "age", 12, 13)],
};
let validation_error2 = ValidationError {
    message: Some("validating a user registration command".into()),
    violations: vec![invalid_value("invalid-length-min", "username", 3, 4)],
};

let merged_error = validation_error2.merge(validation_error1);

assert_eq!(
    merged_error,
    ValidationError {
        message: Some(
            "validating a user registration command / validating a user's age".into()
        ),
        violations: vec![
            invalid_value("invalid-length-min", "username", 3, 4),
            invalid_value("invalid-bound-min", "age", 12, 13),
        ]
    }
);

Trait Implementations

impl Clone for ValidationError

fn clone(&self) -> ValidationError

Returns a copy of the value.

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

Performs copy-assignment from source.

impl PartialEq<ValidationError> for ValidationError

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

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Display for ValidationError

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

Formats the value using the given formatter.

impl Debug for ValidationError

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

Formats the value using the given formatter.

impl Error for ValidationError

fn description(&self) -> &str

This method is soft-deprecated.

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

Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

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

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

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

impl Serialize for ValidationError

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

Serialize this value into the given Serde serializer.

impl<'de> Deserialize<'de> for ValidationError

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.