protoschema 0.1.9

📐 Programmatically define protobuf contracts using flexible, modular and reusable elements
Documentation 
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
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253

use bon::Builder;

use crate::{
  validators::{cel::CelRule, Ignore, OptionValueList},
  OptionValue, ProtoOption,
};

macro_rules! get_list_check {
  (f32, $in_list:expr, $not_in_list:expr) => {{
    let hashable_in_list: Option<Vec<u32>> =
      $in_list.map(|l| l.iter().map(|v| v.to_bits()).collect());

    let hashable_not_in_list: Option<Vec<u32>> =
      $not_in_list.map(|l| l.iter().map(|v| v.to_bits()).collect());

    super::validate_lists(hashable_in_list.as_deref(), hashable_not_in_list.as_deref())
      .unwrap_or_else(|invalid| {
        panic!(
          "The following values are present inside of 'in' and 'not_in': {:?}",
          invalid
            .iter()
            .map(|v| f32::from_bits(*v))
            .collect::<Vec<f32>>()
        )
      });
  }};

  (f64, $in_list:expr, $not_in_list:expr) => {{
    let hashable_in_list: Option<Vec<u64>> =
      $in_list.map(|l| l.iter().map(|v| v.to_bits()).collect());

    let hashable_not_in_list: Option<Vec<u64>> =
      $not_in_list.map(|l| l.iter().map(|v| v.to_bits()).collect());

    super::validate_lists(hashable_in_list.as_deref(), hashable_not_in_list.as_deref())
      .unwrap_or_else(|invalid| {
        panic!(
          "The following values are present inside of 'in' and 'not_in': {:?}",
          invalid
            .iter()
            .map(|v| f64::from_bits(*v))
            .collect::<Vec<f64>>()
        )
      });
  }};

  ($_:ty, $in_list:expr, $not_in_list:expr) => {{
    super::validate_lists($in_list, $not_in_list).unwrap_or_else(|invalid| {
      panic!(
        "The following values are present inside of 'in' and 'not_in': {:?}",
        invalid
      )
    });
  }};
}

macro_rules! get_fields {
  (f64, $_:ident) => {
    /// A struct that can be used to generate a [`ProtoOption`] containing protovalidate rules for a protobuf 'double' field.
    #[derive(Clone, Debug, Builder)]
    pub struct DoubleValidator {
      /// Only this specific value will be considered valid for this field.
      pub const_: Option<f64>,
      /// This field's value will be valid only if it is smaller than the specified amount
      pub lt: Option<f64>,
      /// This field's value will be valid only if it is smaller than, or equal to, the specified amount
      pub lte: Option<f64>,
      /// This field's value will be valid only if it is greater than the specified amount
      pub gt: Option<f64>,
      /// This field's value will be valid only if it is smaller than, or equal to, the specified amount
      pub gte: Option<f64>,
      /// Only the values in this list will be considered valid for this field.
      #[builder(into)]
      pub in_: Option<Box<[f64]>>,
      /// The values in this list will be considered invalid for this field.
      #[builder(into)]
      pub not_in: Option<Box<[f64]>>,
      /// Specifies that this field must be finite (so it can't represent Infinity or NaN)
      #[builder(with = || true)]
      pub finite: Option<bool>,
      /// Adds custom validation using one or more [`CelRule`]s to this field.
      #[builder(into)]
      pub cel: Option<Box<[CelRule]>>,
      /// Marks the field as invalid if unset.
      #[builder(with = || true)]
      pub required: Option<bool>,
      #[builder(setters(vis = "", name = ignore))]
      pub ignore: Option<Ignore>,
    }
  };

  (f32, $_:ident) => {
    /// A struct that can be used to generate a [`ProtoOption`] containing protovalidate rules for a protobuf 'float' field.
    #[derive(Clone, Debug, Builder)]
    pub struct FloatValidator {
      /// Only this specific value will be considered valid for this field.
      pub const_: Option<f32>,
      /// This field's value will be valid only if it is smaller than the specified amount
      pub lt: Option<f32>,
      /// This field's value will be valid only if it is smaller than, or equal to, the specified amount
      pub lte: Option<f32>,
      /// This field's value will be valid only if it is greater than the specified amount
      pub gt: Option<f32>,
      /// This field's value will be valid only if it is smaller than, or equal to, the specified amount
      pub gte: Option<f32>,
      /// Only the values in this list will be considered valid for this field.
      #[builder(into)]
      pub in_: Option<Box<[f32]>>,
      /// The values in this list will be considered invalid for this field.
      #[builder(into)]
      pub not_in: Option<Box<[f32]>>,
      #[builder(with = || true)]
      /// Specifies that this field must be finite (so it can't represent Infinity or NaN)
      pub finite: Option<bool>,
      /// Adds custom validation using one or more [`CelRule`]s to this field.
      #[builder(into)]
      pub cel: Option<Box<[CelRule]>>,
      /// Marks the field as invalid if unset.
      #[builder(with = || true)]
      pub required: Option<bool>,
      #[builder(setters(vis = "", name = ignore))]
      pub ignore: Option<Ignore>,
    }
  };

  ($rust_type:ident, $proto_type:ident) => {
    paste::paste! {
      #[doc = concat!("A struct that can be used to generate a [`ProtoOption`] containing protovalidate rules for a protobuf `")]
      #[doc = concat!(stringify!($proto_type))]
      #[doc = "` field."]
      #[derive(Clone, Debug, Builder)]
        pub struct [< $proto_type:camel Validator >] {
        /// Only this specific value will be considered valid for this field.
        pub const_: Option<$rust_type>,
        /// This field's value will be valid only if it is smaller than the specified amount
        pub lt: Option<$rust_type>,
        /// This field's value will be valid only if it is smaller than, or equal to, the specified amount
        pub lte: Option<$rust_type>,
        /// This field's value will be valid only if it is greater than the specified amount
        pub gt: Option<$rust_type>,
        /// This field's value will be valid only if it is smaller than, or equal to, the specified amount
        pub gte: Option<$rust_type>,
        /// Only the values in this list will be considered valid for this field.
        #[builder(into)]
        pub in_: Option<Box<[$rust_type]>>,
        /// The values in this list will be considered invalid for this field.
        #[builder(into)]
        pub not_in: Option<Box<[$rust_type]>>,
        /// Adds custom validation using one or more [`CelRule`]s to this field.
        #[builder(into)]
        pub cel: Option<Box<[CelRule]>>,
        /// Marks the field as invalid if unset.
        pub required: Option<bool>,
        #[builder(setters(vis = "", name = ignore))]
        pub ignore: Option<Ignore>,
      }
    }
  };
}

macro_rules! get_options {
  (Float, $validator:ident, $values:ident) => {
    insert_option!($validator, $values, lt, Float);
    insert_option!($validator, $values, lte, Float);
    insert_option!($validator, $values, gt, Float);
    insert_option!($validator, $values, gte, Float);
    insert_option!($validator, $values, in_, [Float]);
    insert_option!($validator, $values, not_in, [Float]);
    insert_option!($validator, $values, finite, bool);
  };

  ($option_value_variant:ident, $validator:ident, $values:ident) => {
    insert_option!($validator, $values, lt, $option_value_variant);
    insert_option!($validator, $values, lte, $option_value_variant);
    insert_option!($validator, $values, gt, $option_value_variant);
    insert_option!($validator, $values, gte, $option_value_variant);
    insert_option!($validator, $values, in_, [$option_value_variant]);
    insert_option!($validator, $values, not_in, [$option_value_variant]);
  };
}

macro_rules! numeric_validator {
  ($proto_type:ident, $rust_type:ty, $option_value_variant:ident) => {
    paste::paste! {
      get_fields!($rust_type, $proto_type);

      impl_ignore!(no_lifetime, [< $proto_type:camel ValidatorBuilder >]);

      impl<S: [< $proto_type _validator_builder >]::State> From<[< $proto_type:camel ValidatorBuilder >]<S>> for ProtoOption {
        #[doc(hidden)]
        #[track_caller]
        fn from(builder: [< $proto_type:camel ValidatorBuilder >]<S>) -> ProtoOption {
          builder.build().into()
        }
      }

      impl From<[< $proto_type:camel Validator >]> for ProtoOption {
        #[doc(hidden)]
        #[track_caller]
        fn from(validator: [< $proto_type:camel Validator >]) -> ProtoOption {
          let name = "(buf.validate.field)";

          let mut values: OptionValueList = Vec::new();

          if let Some(const_val) = validator.const_ {
            values.push(("const".into(), OptionValue::from(const_val)));
          }

          super::validate_comparables(validator.lt, validator.lte, validator.gt, validator.gte);
          get_list_check!($rust_type, validator.in_.as_deref(), validator.not_in.as_deref());
          get_options!($option_value_variant, validator, values);

          let mut option_value: OptionValueList = vec! [
            (stringify!($proto_type).into(), OptionValue::Message(values.into_boxed_slice()))
          ];

          insert_cel_rule!(validator, option_value);
          insert_option!(validator, option_value, required, bool);

          ProtoOption {
            name: name.into(),
            value: OptionValue::Message(option_value.into_boxed_slice()).into(),
          }
        }
      }

      #[doc(hidden)]
      #[track_caller]
      pub fn [< build_ $proto_type _validator_option >]<F, S>(config_fn: F) -> ProtoOption
      where
        F: FnOnce([< $proto_type:camel ValidatorBuilder >]) -> [< $proto_type:camel ValidatorBuilder >]<S>,
        S: [< $proto_type _validator_builder >]::IsComplete,
      {
        let builder = [< $proto_type:camel Validator >]::builder();
        let validator = config_fn(builder).build();
        validator.into()
      }
    }
  };
}

numeric_validator!(int64, i64, Int);
numeric_validator!(int32, i32, Int);
numeric_validator!(sint64, i64, Int);
numeric_validator!(sint32, i32, Int);
numeric_validator!(sfixed64, i64, Int);
numeric_validator!(sfixed32, i32, Int);
numeric_validator!(uint64, u64, Uint);
numeric_validator!(uint32, u32, Uint);
numeric_validator!(fixed64, u64, Uint);
numeric_validator!(fixed32, u32, Uint);
numeric_validator!(float, f32, Float);
numeric_validator!(double, f64, Float);