1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347
/*!
# Validators
This crate provides many validators for validating data from users and modeling them to structs without much extra effort.
All validators are separated into different modules and unified for two main types: **XXX** and **XXXValidator** where **XXX** is a type that you want to validate.
The former is a struct or a enum, and the latter is a struct which can be considered as a generator of the former.
A **XXXValidator** struct usually contains some values of `ValidatorOption` in order to use different rules to check data.
For example, the mod `domain` has `Domain` and `DomainValidator` structs. If we want to create a `Domain` instance, we need to create a `DomainValidator` instance first.
When initialing a `DomainValidator`, we can choose to make this `DomainValidator` **allow** or **not allow** the input to have or **must** have a port number.
```rust
extern crate validators;
use validators::ValidatorOption;
use validators::domain::{Domain, DomainValidator};
let domain = "tool.magiclen.org:8080".to_string();
let dv = DomainValidator {
port: ValidatorOption::Allow,
localhost: ValidatorOption::NotAllow,
};
let domain = dv.parse_string(domain).unwrap();
assert_eq!("tool.magiclen.org:8080", domain.get_full_domain());
assert_eq!("tool.magiclen.org", domain.get_full_domain_without_port());
assert_eq!("org", domain.get_top_level_domain().unwrap());
assert_eq!("tool", domain.get_sub_domain().unwrap());
assert_eq!("magiclen", domain.get_domain());
assert_eq!(8080, domain.get_port().unwrap());
```
If you want the **XXX** model to be stricter, you can use its wrapper type which is something like **XXXWithPort** or **XXXWithoutPort**.
For instance, `Domain` has some wrappers, such as **DomainLocalhostableWithPort**, **DomainLocalhostableAllowPort** and **DomainLocalhostableWithoutPort**.
```rust
extern crate validators;
use validators::domain::{DomainLocalhostableWithPort};
let domain = "tool.magiclen.org:8080".to_string();
let domain = DomainLocalhostableWithPort::from_string(domain).unwrap();
assert_eq!("tool.magiclen.org:8080", domain.get_full_domain());
assert_eq!("tool.magiclen.org", domain.get_full_domain_without_port());
assert_eq!("org", domain.get_top_level_domain().unwrap());
assert_eq!("tool", domain.get_sub_domain().unwrap());
assert_eq!("magiclen", domain.get_domain());
assert_eq!(8080, domain.get_port()); // This function does not use `Option` as its return value, because the struct `DomainLocalhostableWithPort` has already made sure the input must have a port number!
```
This crate aims to use the simplest and slackest way (normally only use regular expressions) to validate data, in order to minimize the overhead.
Therefore, it may not be competent in some critical situations. Use it carefully. Check out the documentation to see more useful validators and wrapper types.
## Customization
This crate also provides macros to create customized validated structs for any strings, numbers and Vecs.
For example, to create a struct which only allows **"Hi"** or **"Hello"** restricted by a regular expression,
```rust
#[macro_use] extern crate validators;
validated_customized_regex_string!(Greet, "^(Hi|Hello)$");
let s = Greet::from_str("Hi").unwrap();
```
While a regex needs to be compiled before it operates, if you want to reuse a compiled regex, you can add a **ref** keyword, and pass a static Regex instance to the macro,
```rust
#[macro_use] extern crate validators;
#[macro_use] extern crate lazy_static;
extern crate regex;
use regex::Regex;
lazy_static! {
static ref RE_GREET: Regex = {
Regex::new("^(Hi|Hello)$").unwrap()
};
}
validated_customized_regex_string!(Greet, ref RE_GREET);
let s = Greet::from_str("Hi").unwrap();
```
You can also make your struct public by adding a **pub** keyword,
```rust
#[macro_use] extern crate validators;
validated_customized_regex_string!(pub Greet, "^(Hi|Hello)$");
let s = Greet::from_str("Hi").unwrap();
```
For numbers limited in a range,
```rust
#[macro_use] extern crate validators;
validated_customized_ranged_number!(Score, u8, 0, 100);
let score = Score::from_str("80").unwrap();
```
For a Vec whose length is limited in a range,
```rust
#[macro_use] extern crate validators;
validated_customized_regex_string!(Name, "^[A-Z][a-zA-Z]*( [A-Z][a-zA-Z]*)*$");
validated_customized_ranged_length_vec!(Names, 1, 5);
let mut names = Vec::new();
names.push(Name::from_str("Ron").unwrap());
names.push(Name::from_str("Magic Len").unwrap());
let names = Names::from_vec(names).unwrap();
```
For a HashSet whose length is limited in a range,
```rust
#[macro_use] extern crate validators;
use std::collections::HashSet;
validated_customized_regex_string!(Name, "^[A-Z][a-zA-Z]*( [A-Z][a-zA-Z]*)*$");
validated_customized_ranged_length_hash_set!(Names, 1, 5);
let mut names = HashSet::new();
names.insert(Name::from_str("Ron").unwrap());
names.insert(Name::from_str("Magic Len").unwrap());
let names = Names::from_hash_set(names).unwrap();
```
All validated wrapper types and validated customized structs implement the `ValidatedWrapper` trait.
Read the documentation to know more helpful customized macros.
## Phone Number Support
This crate supports [phonenumber](https://crates.io/crates/phonenumber) crate. You can create validators for phone numbers by using the `validated_customized_phone_number` macro.
To use it, you have to enable **phone-number** feature for this crate.
```toml
[dependencies.validators]
version = "*"
features = ["phone-number"]
```
For example,
```rust,ignore
#[macro_use] extern crate validators;
use validators::PhoneNumberCountry;
validated_customized_phone_number!(P1, PhoneNumberCountry::TW);
validated_customized_phone_number!(pub P2, PhoneNumberCountry::CN, PhoneNumberCountry::US);
let phone_number = P1::from_str("0912345678").unwrap();
assert_eq!("0912345678", phone_number.get_full_phone_number());
assert!(phone_number.get_countries().contains(&PhoneNumberCountry::TW));
let phone_number = P2::from_str("626-555-1212").unwrap();
assert_eq!("626-555-1212", phone_number.get_full_phone_number());
assert!(phone_number.get_countries().contains(&PhoneNumberCountry::US));
```
## Rocket Support
This crate supports [Rocket](https://rocket.rs/) framework. All validated wrapper types and validated customized structs implement the `FromFormValue` and `FromParam` traits.
To use with Rocket support, you have to enable **rocketly** feature for this crate.
```toml
[dependencies.validators]
version = "*"
features = ["rocketly"]
```
For example,
```rust,ignore
#![feature(plugin)]
#![feature(custom_derive)]
#![plugin(rocket_codegen)]
#[macro_use] extern crate validators;
extern crate rocket;
use rocket::request::Form;
use validators::http_url::HttpUrlUnlocalableWithProtocol;
use validators::email::Email;
validated_customized_ranged_number!(PersonID, u8, 0, 100);
validated_customized_regex_string!(Name, r"^[\S ]{1,80}$");
validated_customized_ranged_number!(PersonAge, u8, 0, 130);
#[derive(Debug, FromForm)]
struct ContactModel {
name: Name,
age: Option<PersonAge>,
email: Email,
url: Option<HttpUrlUnlocalableWithProtocol>
}
#[post("/contact/<id>", data = "<model>")]
fn contact(id: PersonID, model: Form<ContactModel>) -> &'static str {
println!("{}", id);
println!("{:?}", model.get());
"do something..."
}
```
## Serde Support
Serde is a framework for serializing and deserializing Rust data structures efficiently and generically. And again, this crate supports [Serde](https://crates.io/crates/serde) framework.
All validated wrapper types and validated customized structs implement the `Serialize` and `Deserialize` traits.
To use with Serde support, you have to enable **serdely** feature for this crate.
```toml
[dependencies.validators]
version = "*"
features = ["serdely"]
```
For example,
```rust,ignore
#[macro_use] extern crate validators;
#[macro_use] extern crate serde_json;
validated_customized_regex_string!(Name, "^[A-Z][a-zA-Z]*( [A-Z][a-zA-Z]*)*$");
validated_customized_ranged_length_vec!(Names, 1, 5);
let mut names = Vec::new();
names.push(Name::from_str("Ron").unwrap());
names.push(Name::from_str("Magic Len").unwrap());
let names = Names::from_vec(names).unwrap();
assert_eq!("[\"Ron\",\"Magic Len\"]", json!(names).to_string());
```
Also, the `json`, `json_array` and `json_object` modules are available.
*/
#![cfg_attr(feature = "nightly", feature(ip))]
#[doc(hidden)]
pub extern crate regex;
#[macro_use]
pub extern crate lazy_static;
#[cfg(feature = "rocketly")]
pub extern crate rocket;
#[cfg(feature = "serdely")]
#[macro_use]
pub extern crate serde;
#[cfg(feature = "phone-number")]
pub extern crate phonenumber;
pub extern crate number_as;
mod validator_option;
pub use validator_option::*;
use std::fmt::{Display, Debug};
pub trait Validated: Display + PartialEq + Clone + Debug {}
pub trait ValidatedWrapper: Validated {
type Error: Display + PartialEq + Clone + Debug;
fn from_string(from_string_input: String) -> Result<Self, Self::Error>;
fn from_str(from_str_input: &str) -> Result<Self, Self::Error>;
}
pub mod domain;
pub mod email;
pub mod ipv4;
pub mod ipv6;
pub mod host;
pub mod http_url;
pub mod http_ftp_url;
pub mod base64;
pub mod base64_url;
pub mod base32;
pub mod short_crypt_url_component;
pub mod short_crypt_qr_code_alphanumeric;
#[cfg(feature = "serdely")]
pub mod json;
#[cfg(feature = "serdely")]
pub mod json_object;
#[cfg(feature = "serdely")]
pub mod json_array;
pub mod uuid;
pub mod mac_address;
pub mod version;
pub mod uri;
pub mod text;
pub mod line;
pub mod number;
pub mod integer;
pub mod boolean;
mod macro_validated_customized_string;
mod macro_validated_customized_number;
mod macro_validated_customized_vec;
mod macro_validated_customized_hash_set;
#[cfg(feature = "phone-number")]
mod macro_validated_customized_phone_number;
pub use self::macro_validated_customized_string::*;
pub use self::macro_validated_customized_number::*;
pub use self::macro_validated_customized_vec::*;
pub use self::macro_validated_customized_hash_set::*;
#[cfg(feature = "phone-number")]
pub use self::macro_validated_customized_phone_number::*;