Struct ValidationError

pub struct ValidationError<Key> {
    pub key: Key,
    pub type_id: &'static str,
    /* private fields */
}

An error associated with a form field.

Fields

key: Key

The key for the field that this validation error is associated with.

type_id: &'static str

An identifier for the type of error this is.

Implementations

impl<Key> ValidationError<Key>

pub fn new(key: Key, type_id: &'static str) -> Self

Create a new ValidationError with a generic message, and specify the type_id which allows the error type to be identified programatically.

pub fn message<S: Into<String>>(self, message: S) -> Self

Factory method to set the message for this error.

pub fn with_message<F: Fn(&Key) -> String + 'static>( self, message_fn: F, ) -> Self

Factory method to set the message for this error from a function that returns a String.

Example

use form_validation::ValidationError;

let value = -10;
let error = ValidationError::new("field1", "NOT_LESS_THAN_0")
    .with_message(move |key| {
        format!(
           "The value of {} ({}) cannot be less than 0",
            key, value)
});

assert_eq!("The value of field1 (-10) cannot be less than 0", error.to_string());
assert_eq!("NOT_LESS_THAN_0", error.type_id);

Trait Implementations

impl<Key> Clone for ValidationError<Key>

where Key: Clone,

fn clone(&self) -> Self

Returns a copy of the value.

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

Performs copy-assignment from source.

impl<Key> Debug for ValidationError<Key>

where Key: Debug,

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

Formats the value using the given formatter.

impl<Key> Display for ValidationError<Key>

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

Formats the value using the given formatter.

impl<Key> Error for ValidationError<Key>

where Key: Debug,

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<Key> From<ValidationError<Key>> for ValidationErrors<Key>

where Key: Clone + PartialEq,

fn from(err: ValidationError<Key>) -> Self

Converts to this type from the input type.

impl<Key> PartialEq for ValidationError<Key>

where Key: PartialEq,

fn eq(&self, other: &Self) -> 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.