[−][src]Crate validr
Validr
Is a validation crate.
Validr will allow you to modify your payload after it has been deserialized and then will validate it with the rules you give it.
usage:
#[macro_use] use validr::*; use serde::Deserialize; use actix_web::{web, HttpResponse, ResponseError}; #[derive(Clone, Deserialize, Debug)] struct TestObj { pub name: Option<String>, pub email: Option<String>, pub age: Option<u8> } impl Validation for TestObj { fn modifiers(&self) -> Vec<Modifier<Self>> { vec![ modifier_trim!(name), modifier_capitalize!(name), modifier_lowercase!(email), ] } fn rules(&self) -> Vec<Rule<Self>> { vec![ rule_required!(name), rule_required!(email), rule_email!(email), ] } } async fn test_actix_route_handler(test: web::Json<TestObj>) -> HttpResponse { match test.into_inner().validate() { Ok(item) => { println!("This is your data validated and modified: {:?}", item); HttpResponse::Ok().body("Validation passed!") }, Err(e) => e.error_response(), } }
Validation rules
There are some rules predefined and provided for you in a form of a macro to simply include in your validation.
Required
For Option<T: ToString + Clone> it will check if the field is present
For String it will check if it's not empty.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_required!(field_name_on_self)] }
For Option<T: ToString + Clone> it will check if the field is present and valid email
For String it will check if it's valid email.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_email!(field_name_on_self)] }
Url
For Option<T: ToString + Clone> it will check if the field is present and valid url
For String it will check if it's valid url.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_url!(field_name_on_self)] }
Phone
For Option<T: ToString + Clone> it will check if the field is present and valid phone number
For String it will check if it's valid phone number.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_phone!(field_name_on_self)] }
Non Control Character
For Option<T: ToString + Clone> it will check if the field is present and has no control characters
For String it will check if the field has no control characters
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_non_control_character!(field_name_on_self)] }
IP
For Option<T: ToString + Clone> it will check if the field is present and valid IP
For String it will check if it's valid IP.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_ip!(field_name_on_self)] }
IP V4
For Option<T: ToString + Clone> it will check if the field is present and valid IP V4
For String it will check if it's valid IP V4.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_ip_v4!(field_name_on_self)] }
IP V6
For Option<T: ToString + Clone> it will check if the field is present and valid IP V6
For String it will check if it's valid IP V6.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_ip_v6!(field_name_on_self)] }
Credit card
For Option<T: ToString + Clone> it will check if the field is present and valid CC number
For String it will check if it's valid CC number.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_credit_card!(field_name_on_self)] }
Contains
For Option<T: ToString + Clone> it will check if the field is present and contains given needle
For String it will check if it contains given needle.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_contains!(field_name_on_self, "needle")] }
Equal to
It validates if two given field names are equal.
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_equalt_to!(field_name_on_self, field_name_to_compare_to_on_self)] }
In
For Option<T: ToString + Clone> it will check if the field is present and will match its value to haystack of values
For String it will check if its in the haystack value
fn rules(&self) -> Vec<Rule<Self>> { vec![ rule_in!(field_name_on_self, vec![ "allowed_value".to_string(), "another_allowed_value".to_string() ]), ] }
Lenght min
For Option<T: ToString + Clone> it will check if the field is present and has min number of chars
For String it will check if it has min number of chars
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_lenght_min!(field_name_on_self, 2)] }
Lenght max
For Option<T: ToString + Clone> it will check if the field is present and has max number of chars
For String it will check if it has max number of chars
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_lenght_max!(field_name_on_self, 15)] }
Lenght equal
For Option<T: ToString + Clone> it will check if the field is present and has eq number of chars
For String it will check if it has eq number of chars
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_lenght_eq!(field_name_on_self, 10)] }
Lenght not equal
For Option<T: ToString + Clone> it will check if the field is present and has ne number of chars
For String it will check if it has ne number of chars
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_lenght_ne!(field_name_on_self, 11)] }
Range
For Option<T: Into<f64> + PartialOrd + Clone> it will check that the value is present and within given range.
For T: Into<f64> it will check if the value is in the given range
fn rules(&self) -> Vec<Rule<Self>> { vec![rule_range!(field_name_on_self, 11)] }
Custom validation rule
You can always implement a custom validation rule by instead of using provided
macros generate your own Rule::new() definition:
use validr::{Rule, ValidationError}; fn rules(&self) -> Vec<Rule<Self>> { vec![ Rule::new("field_name", |obj: &Self, error: &mut ValidationError| { if obj.field_name != "some_validation_rule".to_string() { error.add("my_custom_error_code"); } }), ] }
Field modifiers
Before running validation rules you can modify the input data to format it in whatever way you want. There are some modifiers included, but you can certainly create a custom one to do whatever you want.
Trim
For Option<String> it will check if there is some value and will run the trim on the value.
For String it will simply trim it
fn modifiers(&self) -> Vec<Modifier<Self>> { vec![modifier_trim!(field_name_on_self)] }
Lowercase
For Option<String> it will check if there is some value and will run the lowercase on the value.
For String it will simply lowercase it
fn modifiers(&self) -> Vec<Modifier<Self>> { vec![modifier_lowercase!(field_name_on_self)] }
Uppercase
For Option<String> it will check if there is some value and will run the uppercase on the value.
For String it will simply uppercase it
fn modifiers(&self) -> Vec<Modifier<Self>> { vec![modifier_uppercase!(field_name_on_self)] }
Capitalize
For Option<String> it will check if there is some value and will run the capitalize on the value.
For String it will simply capitalize it
Capitalize means it will turn the first char of the string to uppercase, and everything else will be lowercase
fn modifiers(&self) -> Vec<Modifier<Self>> { vec![modifier_capitalize!(field_name_on_self)] }
Custom modifier
Implementing custom modifier is similar to custom validation rule, you will provide a custom
implementation of Modifier::new():
use validr::Modifier; fn modifiers(&self) -> Vec<Modifier<Self>> { vec![ Modifier::new("field_name", |obj: &mut Self| { obj.field_name = "new_value".to_string(); }), ] }
Re-exports
pub use crate::validator::Validator; |
Modules
| error | |
| validator | |
| wrappers |
Macros
Structs
| Modifier | |
| Rule |
Traits
| Validation |