Struct RepeatedRules

pub struct RepeatedRules {
    pub min_items: Option<u64>,
    pub max_items: Option<u64>,
    pub unique: Option<bool>,
    pub items: Option<Box<FieldRules>>,
}

RepeatedRules describe the rules applied to repeated values.

Fields

min_items: Option<u64>

min_items requires that this field must contain at least the specified minimum number of items.

Note that min_items = 1 is equivalent to setting a field as required.

message MyRepeated {
   // value must contain at least  2 items
   repeated string value = 1 \[(buf.validate.field).repeated.min_items = 2\];
}

max_items: Option<u64>

max_items denotes that this field must not exceed a certain number of items as the upper limit. If the field contains more items than specified, an error message will be generated, requiring the field to maintain no more than the specified number of items.

message MyRepeated {
   // value must contain no more than 3 item(s)
   repeated string value = 1 \[(buf.validate.field).repeated.max_items = 3\];
}

unique: Option<bool>

unique indicates that all elements in this field must be unique. This rule is strictly applicable to scalar and enum types, with message types not being supported.

message MyRepeated {
   // repeated value must contain unique items
   repeated string value = 1 \[(buf.validate.field).repeated.unique = true\];
}

items: Option<Box<FieldRules>>

items details the rules to be applied to each item in the field. Even for repeated message fields, validation is executed against each item unless skip is explicitly specified.

Note that repeated items are always considered populated. The required rule does not apply.

message MyRepeated {
   // The items in the field `value` must follow the specified rules.
   repeated string value = 1 [(buf.validate.field).repeated.items = {
     string: {
       min_len: 3
       max_len: 10
     }
   }];
}

Implementations

impl RepeatedRules

pub fn min_items(&self) -> u64

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

pub fn max_items(&self) -> u64

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

pub fn unique(&self) -> bool

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

Trait Implementations

impl Clone for RepeatedRules

fn clone(&self) -> RepeatedRules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for RepeatedRules

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

Formats the value using the given formatter.

impl Default for RepeatedRules

fn default() -> Self

Returns the “default value” for a type.

impl Message for RepeatedRules

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 RepeatedRules

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