Struct Validator 

pub struct Validator { /* private fields */ }

Checks input against a rule set.

use rainier_validation::{Rule, Validator};
use serde_json::json;

let validator = Validator::new()
    .rules("email", vec![Rule::Required, Rule::Email])
    .rules("age", vec![Rule::Integer, Rule::Min(18.0)]);

let errors = validator.validate(&json!({ "email": "not-an-email" })).unwrap_err();
assert_eq!(errors.first("email"), Some("The email field must be a valid email address."));
assert!(!errors.has("age"), "an absent optional field does not fail");

Implementations

impl Validator

pub fn new() -> Validator

An empty validator.

pub fn from_rules(rules: Vec<(&'static str, Vec<Rule>)>) -> Validator

Build from a RuleSet.

pub fn rules(self, field: impl Into<String>, rules: Vec<Rule>) -> Validator

Add rules for field.

field may be a dotted path (address.city) or contain * to reach into an array (items.*.quantity).

pub fn custom_message( self, key: impl Into<String>, message: impl Into<String>, ) -> Validator

Override the message for one field.rule pair — custom_message("email.required", "We need your email.").

pub fn custom_messages( self, messages: impl IntoIterator<Item = (impl Into<String>, impl Into<String>)>, ) -> Validator

Add several custom messages.

pub fn validate(&self, input: &Value) -> Result<(), ValidationErrors>

Validate input, returning the failures.

pub fn validated(&self, input: &Value) -> Result<Value, ValidationErrors>

Validate and hand back the input, for chaining.

pub fn validated_only(&self, input: &Value) -> Result<Value, ValidationErrors>

Validate and keep only the fields that had rules.

This is a security feature, not a convenience: it is what stops a client from smuggling an is_admin field into a mass assignment. Only keys you wrote a rule for survive.

Trait Implementations

impl Debug for Validator

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

Formats the value using the given formatter.

impl Default for Validator

fn default() -> Validator

Returns the “default value” for a type.