Struct fog_pack::validator::TimeValidator

pub struct TimeValidator {
    pub comment: String,
    pub max: Timestamp,
    pub min: Timestamp,
    pub ex_max: bool,
    pub ex_min: bool,
    pub in_list: Vec<Timestamp>,
    pub nin_list: Vec<Timestamp>,
    pub query: bool,
    pub ord: bool,
}

Validator for timestamps.

This validator will only pass timestamps. Validation passes if:

• If the in list is not empty, the timestamp must be among the timestamp in the list.
• The timestamp must not be among the timestamp in the nin list.
• The timestamp is less than the maximum in max, or equal to it if ex_max is not set to true.
• The timestamp is greater than the minimum in min, or equal to it if ex_min is not set to true.

Defaults

Fields that aren’t specified for the validator use their defaults instead. The defaults for each field are:

• comment: “”
• max: maximum possible timestamp
• min: minimum possible timestamp
• ex_max: false
• ex_min: false
• in_list: empty
• nin_list: empty
• query: false
• ord: false

Fields

comment: String

An optional comment explaining the validator.

max: Timestamp

The maximum allowed timestamp.

min: Timestamp

The minimum allowed timestamp.

ex_max: bool

Changes max into an exclusive maximum.

ex_min: bool

Changes min into an exclusive maximum.

in_list: Vec<Timestamp>

A vector of specific allowed values, stored under the in field. If empty, this vector is not checked against.

nin_list: Vec<Timestamp>

A vector of specific unallowed values, stored under the nin field.

query: bool

If true, queries against matching spots may have values in the in or nin lists.

ord: bool

If true, queries against matching spots may set the max, min, ex_max, and ex_min values to non-defaults.

Implementations

impl TimeValidator

pub fn new() -> Self

Make a new validator with the default configuration.

pub fn comment(self, comment: impl Into<String>) -> Self

Set a comment for the validator.

pub fn max(self, max: impl Into<Timestamp>) -> Self

Set the maximum allowed value.

pub fn min(self, min: impl Into<Timestamp>) -> Self

Set the minimum allowed value.

pub fn ex_max(self, ex_max: bool) -> Self

Set whether or or not max is an exclusive maximum.

pub fn ex_min(self, ex_min: bool) -> Self

Set whether or or not min is an exclusive maximum.

pub fn in_add(self, add: impl Into<Timestamp>) -> Self

Add a value to the in list.

pub fn nin_add(self, add: impl Into<Timestamp>) -> Self

Add a value to the nin list.

pub fn query(self, query: bool) -> Self

Set whether or not queries can use the in and nin lists.

pub fn ord(self, ord: bool) -> Self

Set whether or not queries can use the max, min, ex_max, and ex_min values.

pub fn build(self) -> Validator

Build this into a Validator enum.

Trait Implementations

impl Clone for TimeValidator

fn clone(&self) -> TimeValidator

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for TimeValidator

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

Formats the value using the given formatter.

impl Default for TimeValidator

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for TimeValidator where
    TimeValidator: Default, 

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error> where
    __D: Deserializer<'de>, 

Deserialize this value from the given Serde deserializer.

impl PartialEq<TimeValidator> for TimeValidator

fn eq(&self, other: &TimeValidator) -> bool

This method tests for self and other values to be equal, and is used by ==.

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

This method tests for !=.

impl Serialize for TimeValidator

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

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for TimeValidator