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 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736
//! # Serde Valid
//!
//! [![Latest Version](https://img.shields.io/crates/v/serde_valid.svg?color=green&style=flat-square)](https://crates.io/crates/serde_valid)
//! [![GitHub license](https://badgen.net/github/license/Naereen/Strapdown.js?style=flat-square)](https://github.com/Naereen/StrapDown.js/blob/master/LICENSE)
//!
//! This is [JSON Schema](https://json-schema.org/) based validation tool using with [serde](https://github.com/serde-rs/serde).
//!
//! ## Usage
//!
//! You derive `Validate` trait, and write validations.
//!
//! ```rust
//! use serde_valid::Validate;
//!
//! #[derive(Validate)]
//! struct Data {
//! #[validate(minimum = 0)]
//! #[validate(maximum = 10)]
//! val: i32,
//! }
//!
//! #[derive(Validate)]
//! enum DataEnum {
//! Named {
//! #[validate]
//! a: Data,
//! },
//! }
//!
//! let s = DataEnum::Named {
//! a: Data { val: 5 },
//! };
//!
//! assert!(s.validate().is_ok());
//! ```
//!
//! ## Feature Flags
//!
//! - `toml` - provide serialization/deserialization in `toml` format.
//! - `yaml` - provide serialization/deserialization in `yaml` format.
//! - `i128` - support `i128`/`u128` type (default).
//! - `flatten` - change formatting to flattened error messages ( [jsonschema](https://docs.rs/jsonschema/latest/jsonschema/) crate style).
//!
//! ## Validations
//!
//! Serde Valid support standard validation based JSON Schema.
//!
//! | Type | Serde Valid(validate derive) | Serde Valid(validate trait) | Json Schema |
//! | :-----: | :----------------------------------- | :--------------------------- | :-------------------------------------------------------------------------------------------- |
//! | String | `#[validate(max_length = 5)]` | [`ValidateMaxLength`] | [maxLength](https://json-schema.org/understanding-json-schema/reference/string#length) |
//! | String | `#[validate(min_length = 5)]` | [`ValidateMinLength`] | [minLength](https://json-schema.org/understanding-json-schema/reference/string#length) |
//! | String | `#[validate(pattern = r"^\d{5}$")]` | [`ValidatePattern`] | [pattern](https://json-schema.org/understanding-json-schema/reference/string#regexp) |
//! | Numeric | `#[validate(maximum = 5)]` | [`ValidateMaximum`] | [maximum](https://json-schema.org/understanding-json-schema/reference/numeric#range) |
//! | Numeric | `#[validate(minimum = 5)]` | [`ValidateMinimum`] | [minimum](https://json-schema.org/understanding-json-schema/reference/numeric#range) |
//! | Numeric | `#[validate(exclusive_maximum = 5)]` | [`ValidateExclusiveMaximum`] | [exclusiveMaximum](https://json-schema.org/understanding-json-schema/reference/numeric#range) |
//! | Numeric | `#[validate(exclusive_minimum = 5)]` | [`ValidateExclusiveMinimum`] | [exclusiveMinimum](https://json-schema.org/understanding-json-schema/reference/numeric#range) |
//! | Numeric | `#[validate(multiple_of = 5)]` | [`ValidateMultipleOf`] | [multipleOf](https://json-schema.org/understanding-json-schema/reference/numeric#multiples) |
//! | Object | `#[validate(max_properties = 5)]` | [`ValidateMaxProperties`] | [maxProperties](https://json-schema.org/understanding-json-schema/reference/object#size) |
//! | Object | `#[validate(min_properties = 5)]` | [`ValidateMinProperties`] | [minProperties](https://json-schema.org/understanding-json-schema/reference/object#size) |
//! | Array | `#[validate(max_items = 5)]` | [`ValidateMaxItems`] | [maxItems](https://json-schema.org/understanding-json-schema/reference/array#length) |
//! | Array | `#[validate(min_items = 5)]` | [`ValidateMinItems`] | [minItems](https://json-schema.org/understanding-json-schema/reference/array#length) |
//! | Array | `#[validate(unique_items)]` | [`ValidateUniqueItems`] | [uniqueItems](https://json-schema.org/understanding-json-schema/reference/array#uniqueItems) |
//! | Generic | `#[validate(enumerate(5, 10, 15))]` | [`ValidateEnumerate`] | [enum](https://json-schema.org/understanding-json-schema/reference/enum) |
//!
//! ## Complete Constructor (Deserialization)
//!
//! Serde Valid support complete constructor method using by
//! [`serde_valid::json::FromJsonValue`](json::FromJsonValue) trait.
//!
//! ```rust
//! use serde::Deserialize;
//! use serde_valid::Validate;
//! use serde_valid::json::{json, FromJsonValue};
//!
//! #[derive(Debug, Deserialize, Validate)]
//! struct Data {
//! #[validate(maximum = 100)]
//! val: i32,
//! }
//!
//! // Deserialization and Validation!! 🚀
//! let err = Data::from_json_value(json!({ "val": 123 })).unwrap_err();
//!
//! assert_eq!(
//! err.as_validation_errors().unwrap().to_string(),
//! json!({
//! "errors": [],
//! "properties": {
//! "val": {
//! "errors": ["The number must be `<= 100`."]
//! }
//! }
//! })
//! .to_string()
//! );
//! ```
//!
//! You can force validation by only deserialization through `serde_valid`, and removing
//! `serde_json` from `Cargo.toml` of your project.
//!
//! ## Serialization
//!
//! For serialization, provides [`serde_valid::json::ToJsonString`](json::ToJsonString) trait.
//!
//! ```rust
//! use serde::Serialize;
//! use serde_valid::Validate;
//! use serde_valid::json::{json, ToJsonString};
//!
//! #[derive(Debug, Serialize, Validate)]
//! struct Data {
//! #[validate(maximum = 100)]
//! val: i32,
//! }
//!
//! assert_eq!(
//! Data{ val: 12i32 }.to_json_string().unwrap(),
//! json!({ "val": 12i32 }).to_json_string().unwrap()
//! );
//! ```
//!
//! ## Custom Message
//!
//! For user custom message, Serde Valid provides `message_fn` or `message`.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! #[inline]
//! fn min_error_message(_params: &serde_valid::MinItemsError) -> String {
//! "this is min custom message_fn.".to_string()
//! }
//!
//! #[derive(Validate)]
//! struct Data {
//! #[validate(min_items = 4, message_fn(min_error_message))]
//! #[validate(max_items = 2, message = "this is max custom message.")]
//! val: Vec<i32>,
//! }
//!
//! let s = Data { val: vec![1, 2, 3] };
//!
//! assert_eq!(
//! s.validate().unwrap_err().to_string(),
//! json!({
//! "errors": [],
//! "properties": {
//! "val": {
//! "errors": [
//! "this is min custom message_fn.",
//! "this is max custom message."
//! ]
//! }
//! }
//! })
//! .to_string()
//! );
//! ```
//!
//! ### Fluent localization
//!
//! You can also use [fluent](https://projectfluent.org/) localization by using `fluent` feature.
//!
//! ```rust
//! # #[cfg(feature = "fluent")] {
//! # use fluent::{FluentBundle, FluentResource};
//! use unic_langid::LanguageIdentifier;
//! use serde_json::json;
//! use serde_valid::{fluent::Localize, Validate};
//!
//! # fn get_bundle(source: impl Into<String>) -> FluentBundle<FluentResource> {
//! # let res = FluentResource::try_new(source.into()).expect("Failed to parse an FTL string.");
//! # let langid_en: LanguageIdentifier = "ja_JP".parse().expect("Parsing failed");
//! # let mut bundle = FluentBundle::new(vec![langid_en]);
//! # bundle.add_resource(res).unwrap();
//! # bundle
//! # }
//!
//! #[derive(Validate)]
//! struct Data (
//! #[validate(min_length = 3, fluent("name-min-length", min_length = 3))]
//! String,
//! );
//!
//! assert_eq!(
//! Data("田中".to_string()).validate()
//! .unwrap_err()
//! .localize(&get_bundle("name-min-length = 名前の長さは { $min_length } 文字以上でないといけません。"))
//! .to_string(),
//! json!({
//! "errors": ["名前の長さは \u{2068}3\u{2069} 文字以上でないといけません。"]
//! })
//! .to_string()
//! );
//! # }
//! ```
//!
//! ## Custom method
//!
//! You can use your custom validation using by `#[validate(custom)]`.
//!
//! ```rust
//! use serde_valid::Validate;
//!
//! fn user_validation(_val: &i32) -> Result<(), serde_valid::validation::Error> {
//! Ok(())
//! }
//!
//! #[derive(Validate)]
//! struct Data {
//! #[validate(custom(user_validation))]
//! val: i32,
//! }
//!
//! let s = Data { val: 1 };
//!
//! assert!(s.validate().is_ok());
//! ```
//!
//! And you can also use closure.
//!
//! ```rust
//! use serde_valid::Validate;
//!
//! fn user_validation(_val: &i32, param1: bool) -> Result<(), serde_valid::validation::Error> {
//! Ok(())
//! }
//!
//! #[derive(Validate)]
//! struct Data {
//! #[validate(custom(|v| user_validation(v, true)))]
//! val: i32,
//! }
//!
//! let s = Data { val: 1 };
//!
//! assert!(s.validate().is_ok());
//! ```
//!
//! ## Multi Fields Validation
//! ### Custom Validation
//! Now, you can use `#[validate(custom)]` for multi fields validation.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! fn sample_validation(val1: i32, val2: &str) -> Result<(), serde_valid::validation::Error> {
//! Ok(())
//! }
//!
//! #[derive(Validate)]
//! #[validate(custom(|s| sample_validation(s.val1, &s.val2)))]
//! struct Data {
//! val1: i32,
//! val2: String,
//! }
//!
//! let s = Data {
//! val1: 1,
//! val2: "val2".to_owned(),
//! };
//!
//! assert!(s.validate().is_ok());
//! ```
//!
//! ### Rules
//!
//! 🚸 **Warning** 🚸 : this feature is deprecated. Please use `#[validate(custom)]` instead.
//!
//! If you want to check multi fields validation, can use `#[rule]`.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! fn sample_rule(_val1: &i32, _val2: &str) -> Result<(), serde_valid::validation::Error> {
//! Err(serde_valid::validation::Error::Custom(
//! "Rule error.".to_owned(),
//! ))
//! }
//!
//! #[derive(Validate)]
//! #[rule(sample_rule(val2, val1))]
//! struct Data {
//! val1: String,
//! val2: i32,
//! }
//!
//! let s = Data {
//! val1: "val1".to_owned(),
//! val2: 1,
//! };
//!
//! let errors = s.validate().unwrap_err();
//!
//! assert_eq!(
//! errors.to_string(),
//! json!({
//! "errors": ["Rule error."],
//! "properties": {}
//! })
//! .to_string()
//! );
//! ```
//!
//! If you want to use rule to unnamed fields struct, just like this,
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! fn sample_rule(_val1: &i32, _val2: &str) -> Result<(), serde_valid::validation::Error> {
//! Ok(())
//! }
//!
//! #[derive(Validate)]
//! #[rule(sample_rule(0, 1))]
//! struct Data(i32, String);
//!
//! let s = Data(0, "1".to_owned());
//!
//! assert!(s.validate().is_ok());
//! ```
//!
//! And you can also use closure.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! fn sample_rule(_val1: &i32, _val2: &str) -> Result<(), serde_valid::validation::Error> {
//! Ok(())
//! }
//!
//! #[derive(Validate)]
//! #[rule(|val1, val2| sample_rule(val2, val1))]
//! struct Data {
//! val1: String,
//! val2: i32,
//! }
//!
//! let s = Data {
//! val1: "val1".to_owned(),
//! val2: 1,
//! };
//!
//! assert!(s.validate().is_ok());
//! ```
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! fn sample_rule(_val1: &i32, _val2: &str) -> Result<(), serde_valid::validation::Error> {
//! Ok(())
//! }
//!
//! #[derive(Validate)]
//! #[rule(|_0, _1| sample_rule(_0, _1))]
//! struct Data(i32, String);
//!
//! let s = Data(0, "1".to_owned());
//!
//! assert!(s.validate().is_ok());
//! ```
//!
//! ## Validate Traits
//!
//! By implementing the validation trait, Your original type can uses Serde Valid validations.
//!
//! ```rust
//! use serde_valid::Validate;
//!
//! struct MyType(String);
//!
//! impl serde_valid::ValidateMaxLength for MyType {
//! fn validate_max_length(&self, max_length: usize) -> Result<(), serde_valid::MaxLengthError> {
//! self.0.validate_max_length(max_length)
//! }
//! }
//!
//! #[derive(Validate)]
//! struct Data {
//! #[validate(max_length = 5)]
//! val: MyType,
//! }
//!
//! let s = Data {
//! val: MyType(String::from("😍👺🙋🏽👨🎤👨👩👧👦")),
//! };
//!
//! assert!(s.validate().is_ok());
//! ```
//!
//! ## Validation Errors Format
//! ### Named Struct
//! Field errors are output to `properties`.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! #[derive(Validate)]
//! struct Data {
//! #[validate(maximum = 4)]
//! val: u32,
//! }
//!
//! let s = Data { val: 5 };
//!
//! assert_eq!(
//! s.validate().unwrap_err().to_string(),
//! json!({
//! "errors": [],
//! "properties": {
//! "val": {
//! "errors": ["The number must be `<= 4`."]
//! }
//! }
//! })
//! .to_string()
//! );
//! ```
//!
//! ### Unnamed Struct
//! Field errors are output to `items`. The key for `items` is guaranteed to be a string of positive
//! numbers.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! #[derive(Validate)]
//! struct Data (
//! #[validate(maximum = 4)] u32,
//! #[validate(maximum = 3)] u32,
//! );
//!
//! let s = Data ( 5, 4 );
//!
//! assert_eq!(
//! s.validate().unwrap_err().to_string(),
//! json!({
//! "errors": [],
//! "items": {
//! "0": {
//! "errors": ["The number must be `<= 4`."]
//! },
//! "1": {
//! "errors": ["The number must be `<= 3`."]
//! }
//! }
//! })
//! .to_string()
//! );
//! ```
//!
//! ### New Type
//! Field errors are output to `errors`.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! #[derive(Validate)]
//! struct Data (
//! #[validate(maximum = 4)] u32
//! );
//!
//! let s = Data (5);
//!
//! assert_eq!(
//! s.validate().unwrap_err().to_string(),
//! json!({
//! "errors": ["The number must be `<= 4`."]
//! })
//! .to_string()
//! );
//! ```
//!
//! ### Named Enum
//! Variant errors are output to `properties`.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! #[derive(Validate)]
//! enum Data {
//! Named {
//! #[validate(maximum = 5)]
//! a: i32,
//! #[validate(maximum = 5)]
//! b: i32,
//! },
//! }
//!
//! let s = Data::Named { a: 6, b: 6 };
//!
//! assert_eq!(
//! s.validate().unwrap_err().to_string(),
//! json!({
//! "errors": [],
//! "properties": {
//! "a": {
//! "errors": ["The number must be `<= 5`."]
//! },
//! "b": {
//! "errors": ["The number must be `<= 5`."]
//! }
//! }
//! })
//! .to_string()
//! );
//! ```
//!
//! ### Unnamed Enum
//! Variant errors are output to `items`. The key for `items` is guaranteed to be a string of
//! positive numbers.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! #[derive(Validate)]
//! enum Data {
//! Unnamed (
//! #[validate(maximum = 5)] i32,
//! #[validate(maximum = 5)] i32,
//! ),
//! }
//!
//! let s = Data::Unnamed ( 6, 6 );
//!
//! assert_eq!(
//! s.validate().unwrap_err().to_string(),
//! json!({
//! "errors": [],
//! "items": {
//! "0": {
//! "errors": ["The number must be `<= 5`."]
//! },
//! "1": {
//! "errors": ["The number must be `<= 5`."]
//! }
//! }
//! })
//! .to_string()
//! );
//! ```
//!
//! ### Newtype Enum
//! Variant errors are output to `errors`.
//!
//! ```rust
//! use serde_json::json;
//! use serde_valid::Validate;
//!
//! #[derive(Validate)]
//! enum Data {
//! NewType (
//! #[validate(maximum = 5)] i32,
//! ),
//! }
//!
//! let s = Data::NewType ( 6 );
//!
//! assert_eq!(
//! s.validate().unwrap_err().to_string(),
//! json!({
//! "errors": ["The number must be `<= 5`."]
//! })
//! .to_string()
//! );
//! ```
pub mod error;
mod features;
mod traits;
pub mod validation;
use std::collections::HashMap;
use indexmap::IndexMap;
pub use error::{
EnumerateError, Error, ExclusiveMaximumError, ExclusiveMinimumError, MaxItemsError,
MaxLengthError, MaxPropertiesError, MaximumError, MinItemsError, MinLengthError,
MinPropertiesError, MinimumError, MultipleOfError, PatternError, UniqueItemsError,
};
pub use validation::{
ValidateEnumerate, ValidateExclusiveMaximum, ValidateExclusiveMinimum, ValidateMaxItems,
ValidateMaxLength, ValidateMaxProperties, ValidateMaximum, ValidateMinItems, ValidateMinLength,
ValidateMinProperties, ValidateMinimum, ValidateMultipleOf, ValidatePattern,
ValidateUniqueItems,
};
#[allow(unused_imports)]
pub use features::*;
pub mod export {
#[cfg(feature = "fluent")]
pub use fluent;
pub use once_cell;
}
pub trait Validate {
fn validate(&self) -> std::result::Result<(), self::validation::Errors>;
}
impl<T> Validate for Vec<T>
where
T: Validate,
{
fn validate(&self) -> std::result::Result<(), self::validation::Errors> {
let mut items = IndexMap::new();
for (index, item) in self.iter().enumerate() {
if let Err(errors) = item.validate() {
items.insert(index, errors);
}
}
if items.is_empty() {
Ok(())
} else {
Err(self::validation::Errors::Array(
validation::error::ArrayErrors::new(vec![], items),
))
}
}
}
impl<T, const N: usize> Validate for [T; N]
where
T: Validate,
{
fn validate(&self) -> std::result::Result<(), self::validation::Errors> {
let mut items = IndexMap::new();
for (index, item) in self.iter().enumerate() {
if let Err(errors) = item.validate() {
items.insert(index, errors);
}
}
if items.is_empty() {
Ok(())
} else {
Err(self::validation::Errors::Array(
validation::error::ArrayErrors::new(vec![], items),
))
}
}
}
impl<K, V> Validate for HashMap<K, V>
where
V: Validate,
for<'a> &'a K: Into<String>,
{
fn validate(&self) -> std::result::Result<(), self::validation::Errors> {
let mut items = IndexMap::new();
for (key, value) in self.iter() {
if let Err(errors) = value.validate() {
items.insert(key.into(), errors);
}
}
if items.is_empty() {
Ok(())
} else {
Err(self::validation::Errors::Object(
validation::error::ObjectErrors::new(vec![], items),
))
}
}
}
impl<K, V> Validate for IndexMap<K, V>
where
V: Validate,
for<'a> &'a K: Into<String>,
{
fn validate(&self) -> std::result::Result<(), self::validation::Errors> {
let mut items = IndexMap::new();
for (key, value) in self.iter() {
if let Err(errors) = value.validate() {
items.insert(key.into(), errors);
}
}
if items.is_empty() {
Ok(())
} else {
Err(self::validation::Errors::Object(
validation::ObjectErrors::new(vec![], items),
))
}
}
}
impl<T> Validate for Option<T>
where
T: Validate,
{
fn validate(&self) -> std::result::Result<(), self::validation::Errors> {
match self {
Some(value) => value.validate(),
None => Ok(()),
}
}
}
pub use serde_valid_derive::Validate;
#[doc(hidden)]
pub mod helpers {
/// This function is used to avoid [rustc(E0282)](https://doc.rust-lang.org/error_codes/E0282.html) error in `#[validate(custom)]` validator on the struct.
#[inline]
pub fn wrap_closure_validation<T>(
data: &T,
f: impl FnOnce(&T) -> Result<(), crate::validation::Error>,
) -> Result<(), crate::validation::Error> {
f(data)
}
}
#[cfg(test)]
pub mod tests {
pub type Result<T> = std::result::Result<T, Box<dyn std::error::Error>>;
}