Struct BytesValidator 

#[non_exhaustive]
pub struct BytesValidator {

    pub cel: Vec<CelProgram>,
    pub ignore: Ignore,
    pub well_known: Option<WellKnownBytes>,
    pub required: bool,
    pub len: Option<usize>,
    pub min_len: Option<usize>,
    pub max_len: Option<usize>,
    pub pattern: Option<Regex>,
    pub prefix: Option<Bytes>,
    pub suffix: Option<Bytes>,
    pub contains: Option<Bytes>,
    pub in_: Option<SortedList<Bytes>>,
    pub not_in: Option<SortedList<Bytes>>,
    pub const_: Option<Bytes>,
    pub error_messages: Option<Box<BTreeMap<BytesViolation, FixedStr>>>,
}

Validator for the Bytes type.

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.

cel: Vec<CelProgram>

Adds custom validation using one or more CelRules to this field.

ignore: Ignore

The conditions upon which this validator should be skipped.

well_known: Option<WellKnownBytes>

A well known byte format that the target should fit in.

required: bool

Specifies that the field must be set (if optional) or not equal to its zero value (if not optional) in order to be valid.

len: Option<usize>

Specifies that the given bytes field must be of this exact length.

min_len: Option<usize>

Specifies that the given bytes field must have a length that is equal to or higher than the given value.

max_len: Option<usize>

Specifies that the given bytes field must have a length that is equal to or lower than the given value.

pattern: Option<Regex>

Available on crate feature regex only.

Specifies a regex pattern that must be matches by the value to pass validation.

prefix: Option<Bytes>

Specifies a prefix that the value must start with in order to pass validation.

suffix: Option<Bytes>

Specifies a suffix that the value must end with in order to pass validation.

contains: Option<Bytes>

Specifies a subset of bytes that the value must contain in order to pass validation.

in_: Option<SortedList<Bytes>>

Specifies that only the values in this list will be considered valid for this field.

not_in: Option<SortedList<Bytes>>

Specifies that the values in this list will be considered NOT valid for this field.

const_: Option<Bytes>

Specifies that only this specific value will be considered valid for this field.

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

A map of custom error messages.

Implementations

impl BytesValidator

pub fn builder() -> BytesValidatorBuilder

Trait Implementations

impl Clone for BytesValidator

fn clone(&self) -> BytesValidator

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BytesValidator

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

Formats the value using the given formatter.

impl Default for BytesValidator

fn default() -> BytesValidator

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for BytesValidator

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<BytesValidator> for ProtoOption

fn from(validator: BytesValidator) -> Self

Converts to this type from the input type.

impl Hash for BytesValidator

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 PartialEq for BytesValidator

fn eq(&self, other: &Self) -> 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 Serialize for BytesValidator

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl Validator<Bytes> for BytesValidator

type Target = [u8]

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 as ToOwned>::Owned, ) -> Result<(), Vec<CelError>>

Available on crate feature cel only.

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

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

Validates the Target, with customized settings.

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

Returns the optional schema representation for this validator.

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 Eq for BytesValidator