Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
3 changes: 3 additions & 0 deletions crates/serde_valid/src/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -243,3 +243,6 @@ struct_error_params!(
pub candidates: Vec<Literal>,
}
);

#[deprecated(since = "2.0.2", note = "use `EnumError` instead")]
pub type EnumerateError = EnumError;
4 changes: 4 additions & 0 deletions crates/serde_valid/src/lib.rs
Original file line number Diff line number Diff line change
Expand Up @@ -578,6 +578,8 @@ mod traits;
pub mod utils;
pub mod validation;

#[allow(deprecated)]
pub use error::EnumerateError;
pub use error::{
EnumError, Error, ExclusiveMaximumError, ExclusiveMinimumError, MaxItemsError, MaxLengthError,
MaxPropertiesError, MaximumError, MinItemsError, MinLengthError, MinPropertiesError,
Expand All @@ -587,6 +589,8 @@ pub use error::{
pub use features::*;
use indexmap::IndexMap;
use std::{borrow::Cow, collections::HashMap};
#[allow(deprecated)]
pub use validation::ValidateEnumerate;
pub use validation::{
ValidateEnum, ValidateExclusiveMaximum, ValidateExclusiveMinimum, ValidateMaxItems,
ValidateMaxLength, ValidateMaxProperties, ValidateMaximum, ValidateMinItems, ValidateMinLength,
Expand Down
61 changes: 61 additions & 0 deletions crates/serde_valid/src/validation.rs
Original file line number Diff line number Diff line change
Expand Up @@ -19,6 +19,8 @@ pub use error::{
PropertyErrorsMap, PropertyVecErrorsMap, VecErrors,
};
pub use generic::ValidateEnum;
#[allow(deprecated)]
pub use generic::ValidateEnumerate;
use indexmap::IndexMap;
pub use numeric::{
ValidateExclusiveMaximum, ValidateExclusiveMinimum, ValidateMaximum, ValidateMinimum,
Expand Down Expand Up @@ -178,20 +180,66 @@ macro_rules! impl_composited_validation_1args {
}
};
(
$(#[$trait_meta:meta])+
pub trait $ValidateCompositedTrait:ident<T> {
fn $validate_composited_method:ident(
&self,
$limit:ident: T$(,)*
) -> Result<(), Composited<$Error:ty>>;
}
) => {
impl_composited_validation_1args!(
@generic
[#[allow(deprecated)] $(#[$trait_meta])*]
[#[allow(deprecated)]]
pub trait $ValidateCompositedTrait<T> {
fn $validate_composited_method(
&self,
$limit: T,
) -> Result<(), Composited<$Error>>;
}
);
};
(
pub trait $ValidateCompositedTrait:ident<T> {
fn $validate_composited_method:ident(
&self,
$limit:ident: T$(,)*
) -> Result<(), Composited<$Error:ty>>;
}
) => {
impl_composited_validation_1args!(
@generic
[]
[]
pub trait $ValidateCompositedTrait<T> {
fn $validate_composited_method(
&self,
$limit: T,
) -> Result<(), Composited<$Error>>;
}
);
};
(
@generic
[$(#[$trait_meta:meta])*]
[$(#[$impl_meta:meta])*]
pub trait $ValidateCompositedTrait:ident<T> {
fn $validate_composited_method:ident(
&self,
$limit:ident: T$(,)*
) -> Result<(), Composited<$Error:ty>>;
}
) => {
$(#[$trait_meta])*
pub trait $ValidateCompositedTrait<T> {
fn $validate_composited_method(
&self,
limit: T,
) -> Result<(), crate::validation::Composited<$Error>>;
}

$(#[$impl_meta])*
impl<T, U> $ValidateCompositedTrait<T> for Vec<U>
where
T: Copy,
Expand Down Expand Up @@ -220,6 +268,7 @@ macro_rules! impl_composited_validation_1args {
}
}

$(#[$impl_meta])*
impl<T, K, V> $ValidateCompositedTrait<T> for std::collections::HashMap<K, V>
where
T: Copy,
Expand All @@ -245,6 +294,7 @@ macro_rules! impl_composited_validation_1args {
}
}

$(#[$impl_meta])*
impl<T, U, const N: usize> $ValidateCompositedTrait<T> for [U; N]
where
T: Copy,
Expand Down Expand Up @@ -273,6 +323,7 @@ macro_rules! impl_composited_validation_1args {
}
}

$(#[$impl_meta])*
impl<T, U> $ValidateCompositedTrait<T> for Option<U>
where
T: Copy,
Expand Down Expand Up @@ -427,3 +478,13 @@ impl_composited_validation_1args!(
fn validate_composited_enum(&self, candidates: T) -> Result<(), Composited<EnumError>>;
}
);

impl_composited_validation_1args!(
#[deprecated(
since = "2.0.2",
note = "use `ValidateCompositedEnum` and `validate_composited_enum` instead"
)]
pub trait ValidateCompositedEnumerate<T> {
fn validate_composited_enumerate(&self, enumerate: T) -> Result<(), Composited<EnumError>>;
}
);
2 changes: 2 additions & 0 deletions crates/serde_valid/src/validation/error.rs
Original file line number Diff line number Diff line change
Expand Up @@ -7,6 +7,8 @@ mod object_errors;

use std::borrow::Cow;

#[allow(deprecated)]
pub use crate::error::EnumerateError;
pub use crate::error::{
EnumError, ExclusiveMaximumError, ExclusiveMinimumError, MaxItemsError, MaxLengthError,
MaxPropertiesError, MaximumError, MinItemsError, MinLengthError, MinPropertiesError,
Expand Down
3 changes: 3 additions & 0 deletions crates/serde_valid/src/validation/generic.rs
Original file line number Diff line number Diff line change
@@ -1,2 +1,5 @@
mod r#enum;
mod enumerate;
#[allow(deprecated)]
pub use enumerate::ValidateEnumerate;
pub use r#enum::ValidateEnum;
159 changes: 159 additions & 0 deletions crates/serde_valid/src/validation/generic/enumerate.rs
Original file line number Diff line number Diff line change
@@ -0,0 +1,159 @@
#![allow(deprecated)]

use crate::validation::ValidateCompositedEnumerate;
use crate::EnumError;

/// Enumerate validation.
///
/// See <https://json-schema.org/understanding-json-schema/reference/generic.html#enumerated-values>
///
/// Note: `#[validate(enumerate = ...)]` is deprecated; use `#[validate(r#enum = ...)]`.
#[deprecated(
since = "2.0.2",
note = "use `ValidateEnum` and `validate_enum` instead"
)]
pub trait ValidateEnumerate<T> {
fn validate_enumerate(&self, enumerate: &[T]) -> Result<(), EnumError>;
}

macro_rules! impl_validate_generic_enumerate_literal {
($type:ty) => {
impl ValidateEnumerate<$type> for $type {
fn validate_enumerate(&self, enumerate: &[$type]) -> Result<(), EnumError> {
if enumerate.iter().any(|candidate| candidate == self) {
Ok(())
} else {
Err(EnumError::new(enumerate))
}
}
}

impl<T> ValidateCompositedEnumerate<&[$type]> for T
where
T: ValidateEnumerate<$type>,
{
fn validate_composited_enumerate(
&self,
limit: &[$type],
) -> Result<(), crate::validation::Composited<EnumError>> {
self.validate_enumerate(limit)
.map_err(crate::validation::Composited::Single)
}
}
};
}

impl_validate_generic_enumerate_literal!(i8);
impl_validate_generic_enumerate_literal!(i16);
impl_validate_generic_enumerate_literal!(i32);
impl_validate_generic_enumerate_literal!(i64);
#[cfg(feature = "i128")]
impl_validate_generic_enumerate_literal!(i128);
impl_validate_generic_enumerate_literal!(isize);
impl_validate_generic_enumerate_literal!(u8);
impl_validate_generic_enumerate_literal!(u16);
impl_validate_generic_enumerate_literal!(u32);
impl_validate_generic_enumerate_literal!(u64);
#[cfg(feature = "i128")]
impl_validate_generic_enumerate_literal!(u128);
impl_validate_generic_enumerate_literal!(usize);
impl_validate_generic_enumerate_literal!(std::num::NonZeroI8);
impl_validate_generic_enumerate_literal!(std::num::NonZeroI16);
impl_validate_generic_enumerate_literal!(std::num::NonZeroI32);
impl_validate_generic_enumerate_literal!(std::num::NonZeroI64);
#[cfg(feature = "i128")]
impl_validate_generic_enumerate_literal!(std::num::NonZeroI128);
impl_validate_generic_enumerate_literal!(std::num::NonZeroIsize);
impl_validate_generic_enumerate_literal!(std::num::NonZeroU8);
impl_validate_generic_enumerate_literal!(std::num::NonZeroU16);
impl_validate_generic_enumerate_literal!(std::num::NonZeroU32);
impl_validate_generic_enumerate_literal!(std::num::NonZeroU64);
#[cfg(feature = "i128")]
impl_validate_generic_enumerate_literal!(std::num::NonZeroU128);
impl_validate_generic_enumerate_literal!(std::num::NonZeroUsize);
impl_validate_generic_enumerate_literal!(f32);
impl_validate_generic_enumerate_literal!(f64);
impl_validate_generic_enumerate_literal!(char);

macro_rules! impl_validate_generic_enumerate_str {
($type:ty) => {
impl ValidateEnumerate<&'static str> for $type {
fn validate_enumerate(&self, enumerate: &[&'static str]) -> Result<(), EnumError> {
if enumerate.iter().any(|candidate| candidate == self) {
Ok(())
} else {
Err(EnumError::new(enumerate))
}
}
}
};
}

impl_validate_generic_enumerate_str!(&str);
impl_validate_generic_enumerate_str!(String);
impl_validate_generic_enumerate_str!(std::borrow::Cow<'_, str>);
impl_validate_generic_enumerate_str!(&std::ffi::OsStr);
impl_validate_generic_enumerate_str!(std::ffi::OsString);

macro_rules! impl_validate_generic_enumerate_path {
($type:ty) => {
impl ValidateEnumerate<&'static str> for $type {
fn validate_enumerate(&self, enumerate: &[&'static str]) -> Result<(), EnumError> {
if enumerate
.iter()
.any(|candidate| &std::path::Path::new(candidate) == self)
{
Ok(())
} else {
Err(EnumError::new(enumerate))
}
}
}
};
}

impl_validate_generic_enumerate_path!(&std::path::Path);
impl_validate_generic_enumerate_path!(std::path::PathBuf);

impl<T> ValidateCompositedEnumerate<&[&'static str]> for T
where
T: ValidateEnumerate<&'static str>,
{
fn validate_composited_enumerate(
&self,
limit: &[&'static str],
) -> Result<(), crate::validation::Composited<EnumError>> {
self.validate_enumerate(limit)
.map_err(crate::validation::Composited::Single)
}
}

#[cfg(test)]
mod tests {
use super::*;

struct MyType(String);

impl ValidateEnumerate<&'static str> for MyType {
fn validate_enumerate(&self, enumerate: &[&'static str]) -> Result<(), EnumError> {
self.0.validate_enumerate(enumerate)
}
}

#[test]
fn test_validate_integer_vec_type_is_true() {
assert!(ValidateEnumerate::validate_enumerate(&1, &[1, 2, 3]).is_ok());
}

#[test]
fn test_validate_integer_vec_type_is_false() {
assert!(ValidateEnumerate::validate_enumerate(&1, &[2, 3, 4]).is_err());
}

#[test]
fn test_validate_custom_type() {
assert!(
ValidateEnumerate::validate_enumerate(&MyType("a".to_string()), &["a", "b"]).is_ok()
);
}
}