Struct MapRules

pub struct MapRules {
    pub min_pairs: Option<u64>,
    pub max_pairs: Option<u64>,
    pub keys: Option<Box<FieldRules>>,
    pub values: Option<Box<FieldRules>>,
}

MapRules describe the rules applied to map values.

Fields

min_pairs: Option<u64>

Specifies the minimum number of key-value pairs allowed. If the field has fewer key-value pairs than specified, an error message is generated.

message MyMap {
   // The field `value` must have at least 2 key-value pairs.
   map<string, string> value = 1 \[(buf.validate.field).map.min_pairs = 2\];
}

max_pairs: Option<u64>

Specifies the maximum number of key-value pairs allowed. If the field has more key-value pairs than specified, an error message is generated.

message MyMap {
   // The field `value` must have at most 3 key-value pairs.
   map<string, string> value = 1 \[(buf.validate.field).map.max_pairs = 3\];
}

keys: Option<Box<FieldRules>>

Specifies the rules to be applied to each key in the field.

Note that map keys are always considered populated. The required rule does not apply.

message MyMap {
   // The keys in the field `value` must follow the specified rules.
   map<string, string> value = 1 [(buf.validate.field).map.keys = {
     string: {
       min_len: 3
       max_len: 10
     }
   }];
}

values: Option<Box<FieldRules>>

Specifies the rules to be applied to the value of each key in the field. Message values will still have their validations evaluated unless skip is specified here.

Note that map values are always considered populated. The required rule does not apply.

message MyMap {
   // The values in the field `value` must follow the specified rules.
   map<string, string> value = 1 [(buf.validate.field).map.values = {
     string: {
       min_len: 5
       max_len: 20
     }
   }];
}

Implementations

impl MapRules

pub fn min_pairs(&self) -> u64

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

pub fn max_pairs(&self) -> u64

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

Trait Implementations

impl Clone for MapRules

fn clone(&self) -> MapRules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MapRules

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

Formats the value using the given formatter.

impl Default for MapRules

fn default() -> Self

Returns the “default value” for a type.

impl Message for MapRules

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 MapRules

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