Struct EnumRules 

pub struct EnumRules {
    pub const: Option<i32>,
    pub defined_only: Option<bool>,
    pub in: Vec<i32>,
    pub not_in: Vec<i32>,
    pub example: Vec<i32>,
}

Available on crate feature protovalidate only.

EnumRules describe the rules applied to enum values.

Fields

const: Option<i32>

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

enum MyEnum {
   MY_ENUM_UNSPECIFIED = 0;
   MY_ENUM_VALUE1 = 1;
   MY_ENUM_VALUE2 = 2;
}

message MyMessage {
   // The field `value` must be exactly MY_ENUM_VALUE1.
   MyEnum value = 1 \[(buf.validate.field).enum.const = 1\];
}

defined_only: Option<bool>

defined_only requires the field value to be one of the defined values for this enum, failing on any undefined value.

enum MyEnum {
   MY_ENUM_UNSPECIFIED = 0;
   MY_ENUM_VALUE1 = 1;
   MY_ENUM_VALUE2 = 2;
}

message MyMessage {
   // The field `value` must be a defined value of MyEnum.
   MyEnum value = 1 \[(buf.validate.field).enum.defined_only = true\];
}

in: Vec<i32>

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

enum MyEnum {
   MY_ENUM_UNSPECIFIED = 0;
   MY_ENUM_VALUE1 = 1;
   MY_ENUM_VALUE2 = 2;
}

message MyMessage {
   // The field `value` must be equal to one of the specified values.
   MyEnum value = 1 \[(buf.validate.field).enum = { in: [1, 2\]}];
}

not_in: Vec<i32>

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

enum MyEnum {
   MY_ENUM_UNSPECIFIED = 0;
   MY_ENUM_VALUE1 = 1;
   MY_ENUM_VALUE2 = 2;
}

message MyMessage {
   // The field `value` must not be equal to any of the specified values.
   MyEnum value = 1 \[(buf.validate.field).enum = { not_in: [1, 2\]}];
}

example: Vec<i32>

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.

enum MyEnum {
   MY_ENUM_UNSPECIFIED = 0;
   MY_ENUM_VALUE1 = 1;
   MY_ENUM_VALUE2 = 2;
}

message MyMessage {
     (buf.validate.field).enum.example = 1,
     (buf.validate.field).enum.example = 2
}

Implementations

impl EnumRules

pub fn containing_rules( &self, field_full_name: &str, ) -> Result<ContainingRules, Vec<i32>>

Available on crate feature protocheck only.

impl EnumRules

pub fn const_rule(&self) -> Option<ConstRule<i32>>

Available on crate feature protocheck only.

impl EnumRules

pub fn const(&self) -> i32

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

pub fn defined_only(&self) -> bool

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

Trait Implementations

impl Clone for EnumRules

fn clone(&self) -> EnumRules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for EnumRules

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

Formats the value using the given formatter.

impl Default for EnumRules

fn default() -> Self

Returns the “default value” for a type.

impl Hash for EnumRules

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 Message for EnumRules

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 EnumRules

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

impl StructuralPartialEq for EnumRules