aboutsummaryrefslogtreecommitdiffstats
path: root/README.md
diff options
context:
space:
mode:
authorVincent Prouillet2017-11-08 16:49:02 +0100
committerVincent Prouillet2017-11-08 16:49:02 +0100
commitcfc3e49f293dff9aadb5b6374c0fc778c8e4ebf7 (patch)
tree12346225fff91703e16ab4c0324cf9d18c4891cc /README.md
parent176c58bc03a9cbcb03087e17ddd5b503ce77fc1f (diff)
parent304ff212e20cd10e2f4bc99a54385db461a3a27d (diff)
downloadvalidator-cfc3e49f293dff9aadb5b6374c0fc778c8e4ebf7.tar.bz2
Merge branch 'master' of https://github.com/valeriansaliou/validator into valeriansaliou-master
Diffstat (limited to 'README.md')
-rw-r--r--README.md20
1 files changed, 14 insertions, 6 deletions
diff --git a/README.md b/README.md
index bbbe4de..f1bd55f 100644
--- a/README.md
+++ b/README.md
@@ -6,17 +6,17 @@ Macros 1.1 custom derive to simplify struct validation inspired by [marshmallow]
[Django validators](https://docs.djangoproject.com/en/1.10/ref/validators/).
It relies on the `proc_macro` feature which is stable since Rust 1.15.
-By default all args to a `validate` must be strings if you are using stable.
+By default all args to a `validate` must be strings if you are using stable.
However, if you are using nightly, you can also activate the `attr_literals` feature to be able to use int, float and boolean as well.
A short example:
```rust
-#[macro_use]
+#[macro_use]
extern crate validator_derive;
extern crate validator;
-#[macro_use]
+#[macro_use]
extern crate serde_derive;
extern crate serde_json;
@@ -27,6 +27,8 @@ use validator::{Validate, ValidationError};
struct SignupData {
#[validate(email)]
mail: String,
+ #[validate(phone)]
+ phone: String,
#[validate(url)]
site: String,
#[validate(length(min = "1"), custom = "validate_unique_username")]
@@ -152,8 +154,7 @@ Examples:
```
### credit\_card
-Test whetever the string is a valid credit card number. To use this validator,
-you must enable the `credit_cards` feature for the `validator` crate.
+Test whetever the string is a valid credit card number.
Examples:
@@ -161,8 +162,15 @@ Examples:
#[validate(credit_card)]
```
+### phone
+Tests whether the String is a valid phone number (in international format, ie.
+containing the country indicator like `+14152370800` for an US number — where `4152370800`
+is the national number equivalent, which is seen as invalid).
+To use this validator, you must enable the `phone` feature for the `validator` crate.
+This validator doesn't take any arguments: `#[validate(phone)]`;
+
### custom
-Calls one of your function to do a custom validation.
+Calls one of your function to do a custom validation.
The field will be given as parameter and it should return a `Option<String>` representing the error code,
if there was an error.