Struct FloatRules

pub struct FloatRules {
    pub const: Option<f32>,
    pub in: Vec<f32>,
    pub not_in: Vec<f32>,
    pub finite: Option<bool>,
    pub example: Vec<f32>,
    pub less_than: Option<LessThan>,
    pub greater_than: Option<GreaterThan>,
}

FloatRules describes the rules applied to float values. These rules may also be applied to the google.protobuf.FloatValue Well-Known-Type.

Fields

const: Option<f32>

const requires the field value to exactly match the specified value. If the field value doesn’t match, an error message is generated.

message MyFloat {
   // value must equal 42.0
   float value = 1 \[(buf.validate.field).float.const = 42.0\];
}

in: Vec<f32>

in requires the field value to be equal to one of the specified values. If the field value isn’t one of the specified values, an error message is generated.

message MyFloat {
   // value must be in list \[1.0, 2.0, 3.0\]
   float value = 1 \[(buf.validate.field).float = { in: [1.0, 2.0, 3.0\] }];
}

not_in: Vec<f32>

in requires the field value to not be equal to any of the specified values. If the field value is one of the specified values, an error message is generated.

message MyFloat {
   // value must not be in list \[1.0, 2.0, 3.0\]
   float value = 1 \[(buf.validate.field).float = { not_in: [1.0, 2.0, 3.0\] }];
}

finite: Option<bool>

finite requires the field value to be finite. If the field value is infinite or NaN, an error message is generated.

example: Vec<f32>

example specifies values that the field may have. These values SHOULD conform to other rules. example values will not impact validation but may be used as helpful guidance on how to populate the given field.

message MyFloat {
   float value = 1 [
     (buf.validate.field).float.example = 1.0,
     (buf.validate.field).float.example = inf
   ];
}

less_than: Option<LessThan>

greater_than: Option<GreaterThan>

Implementations

impl FloatRules

pub fn const(&self) -> f32

Returns the value of const, or the default value if const is unset.

pub fn finite(&self) -> bool

Returns the value of finite, or the default value if finite is unset.

Trait Implementations

impl Clone for FloatRules

fn clone(&self) -> FloatRules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FloatRules

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

Formats the value using the given formatter.

impl Default for FloatRules

fn default() -> Self

Returns the “default value” for a type.

impl Message for FloatRules

fn encoded_len(&self) -> usize

Returns the encoded length of the message without a length delimiter.

fn clear(&mut self)

Clears the message, resetting all fields to their default.

fn encode(&self, buf: &mut impl BufMut) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited( &self, buf: &mut impl BufMut, ) -> Result<(), EncodeError>

where Self: Sized,

Encodes the message with a length-delimiter to a buffer.

fn encode_length_delimited_to_vec(&self) -> Vec<u8>

where Self: Sized,

Encodes the message with a length-delimiter to a newly allocated buffer.

fn decode(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited(buf: impl Buf) -> Result<Self, DecodeError>

where Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited(&mut self, buf: impl Buf) -> Result<(), DecodeError>

where Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for FloatRules

fn eq(&self, other: &FloatRules) -> 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 StructuralPartialEq for FloatRules