Struct MapValidator 

#[non_exhaustive]
pub struct MapValidator<K, V>
where
    K: ProtoValidation,
    V: ProtoValidation,
{
    pub keys: Option<K::Validator>,
    pub cel: Vec<CelProgram>,
    pub values: Option<V::Validator>,
    pub min_pairs: Option<usize>,
    pub max_pairs: Option<usize>,
    pub ignore: Ignore,
    pub error_messages: Option<Box<BTreeMap<MapViolation, FixedStr>>>,
    /* private fields */
}

Validator for types that implement ProtoMap.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

keys: Option<K::Validator>

The validation rules to apply to the keys of this map field.

cel: Vec<CelProgram>

values: Option<V::Validator>

The validation rules to apply to the keys of this map field.

min_pairs: Option<usize>

The minimum amount of key-value pairs that this field should have in order to be valid.

max_pairs: Option<usize>

The maximum amount of key-value pairs that this field should have in order to be valid.

ignore: Ignore

error_messages: Option<Box<BTreeMap<MapViolation, FixedStr>>>

Implementations

impl<K, V> MapValidator<K, V>

where K: ProtoValidation, V: ProtoValidation,

pub fn builder() -> MapValidatorBuilder<K, V>

impl<K, V> MapValidator<K, V>

where K: ProtoValidation, V: ProtoValidation,

pub fn validate_map<M>( &self, ctx: &mut ValidationCtx, val: Option<&M>, ) -> ValidationResult

where M: Map<K::Stored, V::Stored> + Clone, K::Stored: Sized + Clone + IntoCelKey + Into<Subscript>, V::Stored: Sized + Clone + TryIntoCel, K: AsProtoType, V: AsProtoType,

Validates the given map. Given as a separate method to avoid trait resolution issues given the implementation for several kinds of map.

Trait Implementations

impl<K, V> Clone for MapValidator<K, V>

where K: ProtoValidation, V: ProtoValidation,

fn clone(&self) -> Self

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<K, V> Debug for MapValidator<K, V>

where K: ProtoValidation + Debug, V: ProtoValidation + Debug, K::Validator: Debug, V::Validator: Debug,

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl<K, V> Default for MapValidator<K, V>

where K: ProtoValidation, V: ProtoValidation,

fn default() -> Self

Returns the “default value” for a type.

impl<'de, K, V> Deserialize<'de> for MapValidator<K, V>

where K: ProtoValidation, V: ProtoValidation, K::Validator: DeserializeOwned, V::Validator: DeserializeOwned,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<K, V> From<MapValidator<K, V>> for ProtoOption

where K: ProtoValidation, V: ProtoValidation,

fn from(validator: MapValidator<K, V>) -> Self

Converts to this type from the input type.

impl<K, V> Hash for MapValidator<K, V>

where K: ProtoValidation + Hash, V: ProtoValidation + Hash, K::Validator: Hash, V::Validator: Hash,

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl<K, V> PartialEq for MapValidator<K, V>

where K: ProtoValidation + PartialEq, V: ProtoValidation + PartialEq, K::Validator: PartialEq, V::Validator: PartialEq,

fn eq(&self, other: &MapValidator<K, V>) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl<K, V> Serialize for MapValidator<K, V>

where K: ProtoValidation, V: ProtoValidation, K::Validator: Serialize, V::Validator: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<K, V, M> Validator<M> for MapValidator<K, V>

where K: ProtoValidation + Send + Sync + AsProtoType, V: ProtoValidation + Send + Sync + AsProtoType, M: ProtoMap<K, V> + ToOwned, M::Target: Clone + Default, K::Stored: Sized + Clone + IntoCelKey + Into<Subscript>, V::Stored: Sized + Clone + TryIntoCel,

type Target = <M as ProtoMap<K, V>>::Target

The target of the validation.

fn check_consistency(&self) -> Result<(), Vec<ConsistencyError>>

Checks if the inputs of the validators are valid.

fn check_cel_programs_with( &self, val: Self::Target, ) -> Result<(), Vec<CelError>>

Available on crate feature cel only.

Tests the CEL programs of this validator with the given value.

fn schema(&self) -> Option<ValidatorSchema>

Returns the optional schema representation for this validator.

fn execute_validation( &self, ctx: &mut ValidationCtx, val: Option<&Self::Target>, ) -> ValidationResult

Validates the Target, with customized settings.

fn validate(&self, val: &Self::Target) -> Result<(), ValidationErrors>

Validates the Target, with the fail_fast setting set to true.

fn validate_option( &self, val: Option<&Self::Target>, ) -> Result<(), ValidationErrors>

Validates the Target, with the fail_fast setting set to true.

fn validate_with_ctx( &self, ctx: ValidationCtx, val: &Self::Target, ) -> Result<(), ValidationErrors>

Validates the Target, with customized settings.

fn validate_option_with_ctx( &self, ctx: ValidationCtx, val: Option<&Self::Target>, ) -> Result<(), ValidationErrors>

Validates the Target, with customized settings.

impl<K, V> Eq for MapValidator<K, V>

where K: ProtoValidation + Eq, V: ProtoValidation + Eq, K::Validator: Eq, V::Validator: Eq,

impl<K, V> StructuralPartialEq for MapValidator<K, V>

where K: ProtoValidation, V: ProtoValidation,