Struct Violation 

#[non_exhaustive]
pub struct Violation {
    pub field: Option<&'static str>,
    pub message: &'static str,
}

A single failed constraint, optionally associated with a named field.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

field: Option<&'static str>

The field name, if validation was run on a named field.

message: &'static str

A human-readable description of the constraint that failed.

Implementations

impl Violation

pub const fn new(message: &'static str) -> Self

Creates a violation without a field name.

pub const fn with_field(field: &'static str, message: &'static str) -> Self

Creates a violation associated with a named field.

Examples found in repository

examples/basic.rs (lines 23-26)

    fn validate(&self) -> Result<(), Self::Error> {
        let mut errors = ValidationError::empty();

        if self.username.len() < 3 {
            errors.push(Violation::with_field(
                "username",
                "must be at least 3 characters",
            ));
        }
        if self.age < 18 {
            errors.push(Violation::with_field("age", "must be 18 or older"));
        }
        if !self.email.contains('@') {
            errors.push(Violation::with_field("email", "must contain '@'"));
        }

        if errors.is_empty() {
            Ok(())
        } else {
            Err(errors)
        }
    }

Trait Implementations

impl Clone for Violation

fn clone(&self) -> Violation

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Violation

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

Formats the value using the given formatter.

impl Display for Violation

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

Formats the value using the given formatter.

impl Eq for Violation

impl Extend<Violation> for ValidationError

Available on crate feature alloc only.

fn extend<I: IntoIterator<Item = Violation>>(&mut self, iter: I)

Extends a collection with the contents of an iterator.

fn extend_one(&mut self, item: A)

🔬This is a nightly-only experimental API. (extend_one)

Extends a collection with exactly one element.

fn extend_reserve(&mut self, additional: usize)

🔬This is a nightly-only experimental API. (extend_one)

Reserves capacity in a collection for the given number of additional elements.

impl From<Violation> for ValidationError

Available on crate feature alloc only.

fn from(v: Violation) -> Self

Converts to this type from the input type.

impl FromIterator<Violation> for ValidationError

Available on crate feature alloc only.

fn from_iter<I: IntoIterator<Item = Violation>>(iter: I) -> Self

Creates a value from an iterator.

impl PartialEq for Violation

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