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

use super::*;
use crate::element::*;
use crate::error::{Error, Result};
use serde::{Deserialize, Serialize};

#[inline]
fn is_false(v: &bool) -> bool {
    !v
}
#[inline]
fn is_nan(v: &f32) -> bool {
    v.is_nan()
}

/// Validator for 32-bit floating-point values.
///
/// This validator will only pass f32 values. Validation passes if:
///
/// - If `max` is a number, that the value is less than the maximum in `max`, or equal to it if
///     `ex_max` is not set to true.
/// - If `min` is a number, that the value is greater than the minimum in `min`, or equal to it if
///     `ex_min` is not set to true.
/// - If the `in` list is not empty, the value must be among the values in it. This performs an
///     exact bit-wise match.
/// - The value must not be among the values in the `nin` list. This performas an exact bit-wise
///     match.
///
/// # Defaults
///
/// Fields that aren't specified for the validator use their defaults instead. The defaults for
/// each field are:
///
/// - comment: ""
/// - max: NaN
/// - min: NaN
/// - ex_max: false
/// - ex_min: false
/// - in_list: empty
/// - nin_list: empty
/// - query: false
/// - ord: false
///
#[derive(Clone, Debug, PartialEq, Serialize, Deserialize)]
#[serde(deny_unknown_fields, default)]
pub struct F32Validator {
    /// An optional comment explaining the validator.
    #[serde(skip_serializing_if = "String::is_empty")]
    pub comment: String,
    /// The maximum allowed f32 value. If NaN, it is ignored.
    #[serde(skip_serializing_if = "is_nan")]
    pub max: f32,
    /// The minimum allowed f32 value. If NaN, it is ignored.
    #[serde(skip_serializing_if = "is_nan")]
    pub min: f32,
    /// Changes `max` into an exclusive maximum.
    #[serde(skip_serializing_if = "is_false")]
    pub ex_max: bool,
    /// Changes `min` into an exclusive maximum.
    #[serde(skip_serializing_if = "is_false")]
    pub ex_min: bool,
    /// A vector of specific allowed values, stored under the `in` field. If empty, this vector is not checked against.
    #[serde(rename = "in", skip_serializing_if = "Vec::is_empty")]
    pub in_list: Vec<f32>,
    #[serde(rename = "nin", skip_serializing_if = "Vec::is_empty")]
    /// A vector of specific unallowed values, stored under the `nin` field.
    pub nin_list: Vec<f32>,
    /// If true, queries against matching spots may have values in the `in` or `nin` lists.
    #[serde(skip_serializing_if = "is_false")]
    pub query: bool,
    /// If true, queries against matching spots may set the `max`, `min`, `ex_max`, and `ex_min`
    /// values to non-defaults.
    #[serde(skip_serializing_if = "is_false")]
    pub ord: bool,
}

impl std::default::Default for F32Validator {
    fn default() -> Self {
        Self {
            comment: String::new(),
            max: f32::NAN,
            min: f32::NAN,
            ex_max: false,
            ex_min: false,
            in_list: Vec::new(),
            nin_list: Vec::new(),
            query: false,
            ord: false,
        }
    }
}

impl F32Validator {
    /// Make a new validator with the default configuration.
    pub fn new() -> Self {
        Self::default()
    }

    /// Set a comment for the validator.
    pub fn comment(mut self, comment: impl Into<String>) -> Self {
        self.comment = comment.into();
        self
    }

    /// Set the maximum allowed value.
    pub fn max(mut self, max: f32) -> Self {
        self.max = max;
        self
    }

    /// Set the minimum allowed value.
    pub fn min(mut self, min: f32) -> Self {
        self.min = min;
        self
    }

    /// Set whether or or not `max` is an exclusive maximum.
    pub fn ex_max(mut self, ex_max: bool) -> Self {
        self.ex_max = ex_max;
        self
    }

    /// Set whether or or not `min` is an exclusive maximum.
    pub fn ex_min(mut self, ex_min: bool) -> Self {
        self.ex_min = ex_min;
        self
    }

    /// Add a value to the `in` list.
    pub fn in_add(mut self, add: f32) -> Self {
        self.in_list.push(add);
        self
    }

    /// Add a value to the `nin` list.
    pub fn nin_add(mut self, add: f32) -> Self {
        self.nin_list.push(add);
        self
    }

    /// Set whether or not queries can use the `in` and `nin` lists.
    pub fn query(mut self, query: bool) -> Self {
        self.query = query;
        self
    }

    /// Set whether or not queries can use the `max`, `min`, `ex_max`, and `ex_min` values.
    pub fn ord(mut self, ord: bool) -> Self {
        self.ord = ord;
        self
    }

    pub(crate) fn validate(&self, parser: &mut Parser) -> Result<()> {
        let elem = parser
            .next()
            .ok_or_else(|| Error::FailValidate("Expected a f32".to_string()))??;
        let elem = if let Element::F32(v) = elem {
            v
        } else {
            return Err(Error::FailValidate(format!(
                "Expected F32, got {}",
                elem.name()
            )));
        };
        let bytes = elem.to_ne_bytes();
        if !self.in_list.is_empty() && !self.in_list.iter().any(|v| v.to_ne_bytes() == bytes) {
            return Err(Error::FailValidate("F32 is not on `in` list".to_string()));
        }
        if self.nin_list.iter().any(|v| v.to_ne_bytes() == bytes) {
            return Err(Error::FailValidate("F32 is on `nin` list".to_string()));
        }
        if !self.max.is_nan() && ((self.ex_max && elem >= self.max) || (elem > self.max)) {
            return Err(Error::FailValidate(
                "F32 greater than maximum allowed".to_string(),
            ));
        }
        if !self.min.is_nan() && ((self.ex_min && elem <= self.min) || (elem < self.min)) {
            return Err(Error::FailValidate(
                "F32 less than maximum allowed".to_string(),
            ));
        }
        Ok(())
    }

    fn query_check_f32(&self, other: &Self) -> bool {
        (self.query || (other.in_list.is_empty() && other.nin_list.is_empty()))
            && (self.ord
                || (!other.ex_min && !other.ex_max && other.min.is_nan() && other.max.is_nan()))
    }

    pub(crate) fn query_check(&self, other: &Validator) -> bool {
        match other {
            Validator::F32(other) => self.query_check_f32(other),
            Validator::Multi(list) => list.iter().all(|other| match other {
                Validator::F32(other) => self.query_check_f32(other),
                _ => false,
            }),
            Validator::Any => true,
            _ => false,
        }
    }
}