Struct Violation 

pub struct Violation { /* private fields */ }

Why a value is invalid.

A violation has a code which identifies the rule that was violated (for instance length), a message for humans and parameters (for instance the minimum length). Codes and parameters are meant for programs, for instance to translate the messages or to point at the value in a user interface.

When a value is invalid, the error has the violation attached (see Error::attachment):

use deser::Deserialize;
use deser_validate::{Check, Email, Violation};

#[derive(Deserialize, Debug)]
struct User {
    #[deser(as = Check<Email>)]
    email: String,
}

let json = r#"{"email": "nope"}"#;
let err = deser_json::from_str::<User>(json).unwrap_err();
assert_eq!(
    err.to_string(),
    "InvalidValue: invalid value: must be an email address \
     at line 1 column 11"
);
assert_eq!(err.attachment::<Violation>().unwrap().code(), "email");

Implementations

impl Violation

pub fn new<C, M>(code: C, message: M) -> Violation

where C: Into<Cow<'static, str>>, M: Into<Cow<'static, str>>,

Creates a violation with a code and a message.

pub fn with_param<P: Into<Param>>( self, name: &'static str, value: P, ) -> Violation

Adds a parameter.

pub fn code(&self) -> &str

Returns the code of the rule that was violated.

pub fn message(&self) -> &str

Returns the message.

pub fn params(&self) -> &[(&'static str, Param)]

Returns the parameters.

pub fn param(&self, name: &str) -> Option<&Param>

Returns the value of a parameter.

pub fn into_error(self) -> Error

Creates the error for the violation.

The error has the violation attached, the message is the same as the one of #[deser(validate = ...)].

Trait Implementations

impl Clone for Violation

fn clone(&self) -> Self

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 ErrorAttachment for Violation

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

Writes the attachment as part of the error message.

impl IntoViolation for Violation

fn into_violation( self, _name: &'static str, _code: Option<&'static str>, ) -> Violation

Converts the error.

impl PartialEq for Violation

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

Equality operator ==.

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

Inequality operator !=.

impl StructuralPartialEq for Violation