Struct data_plane_api::validate::MapRules

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

MapRules describe the constraints applied to map values

Fields

min_pairs: Option<u64>

MinPairs specifies that this field must have the specified number of KVs at a minimum

max_pairs: Option<u64>

MaxPairs specifies that this field must have the specified number of KVs at a maximum

no_sparse: Option<bool>

NoSparse specifies values in this field cannot be unset. This only applies to map’s with message value types.

keys: Option<Box<FieldRules>>

Keys specifies the constraints to be applied to each key in the field.

values: Option<Box<FieldRules>>

Values specifies the constraints 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.

ignore_empty: Option<bool>

IgnoreEmpty specifies that the validation rules of this field should be evaluated only if the field is not empty

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.

pub fn no_sparse(&self) -> bool

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

pub fn ignore_empty(&self) -> bool

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

Trait Implementations

impl Clone for MapRules

fn clone(&self) -> MapRules

Returns a copy 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
    B: BufMut,
    Self: Sized,

Encodes the message to a buffer.

fn encode_to_vec(&self) -> Vec<u8, Global>where
    Self: Sized,

Encodes the message to a newly allocated buffer.

fn encode_length_delimited<B>(&self, buf: &mut B) -> Result<(), EncodeError>where
    B: BufMut,
    Self: Sized,

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

fn encode_length_delimited_to_vec(&self) -> Vec<u8, Global>where
    Self: Sized,

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

fn decode<B>(buf: B) -> Result<Self, DecodeError>where
    B: Buf,
    Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>where
    B: Buf,
    Self: Default,

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

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>where
    B: Buf,
    Self: Sized,

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

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>where
    B: Buf,
    Self: Sized,

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

impl PartialEq<MapRules> for MapRules

fn eq(&self, other: &MapRules) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for MapRules