Struct FieldMaskRules 

pub struct FieldMaskRules {
    pub const: Option<FieldMask>,
    pub in: Vec<String>,
    pub not_in: Vec<String>,
    pub example: Vec<FieldMask>,
}

Available on crate feature protovalidate only.

FieldMaskRules describe rules applied exclusively to the google.protobuf.FieldMask well-known type.

Fields

const: Option<FieldMask>

const dictates that the field must match the specified value of the google.protobuf.FieldMask type exactly. If the field’s value deviates from the specified value, an error message will be generated.

message MyFieldMask {
   // value must equal \["a"\]
   google.protobuf.FieldMask value = 1 [(buf.validate.field).field_mask.const = {
       paths: \["a"\]
   }];
}

in: Vec<String>

in requires the field value to only contain paths matching specified values or their subpaths. If any of the field value’s paths doesn’t match the rule, an error message is generated. See: https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask

message MyFieldMask {
   //  The `value` FieldMask must only contain paths listed in `in`.
   google.protobuf.FieldMask value = 1 [(buf.validate.field).field_mask = {
       in: \["a", "b", "c.a"\]
   }];
}

not_in: Vec<String>

not_in requires the field value to not contain paths matching specified values or their subpaths. If any of the field value’s paths matches the rule, an error message is generated. See: https://protobuf.dev/reference/protobuf/google.protobuf/#field-mask

message MyFieldMask {
   //  The `value` FieldMask shall not contain paths listed in `not_in`.
   google.protobuf.FieldMask value = 1 [(buf.validate.field).field_mask = {
       not_in: \["forbidden", "immutable", "c.a"\]
   }];
}

example: Vec<FieldMask>

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 MyFieldMask {
   google.protobuf.FieldMask value = 1 [
     (buf.validate.field).field_mask.example = { paths: \["a", "b"\] },
     (buf.validate.field).field_mask.example = { paths: \["c.a", "d"\] },
   ];
}

Trait Implementations

impl Clone for FieldMaskRules

fn clone(&self) -> FieldMaskRules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for FieldMaskRules

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

Formats the value using the given formatter.

impl Default for FieldMaskRules

fn default() -> Self

Returns the “default value” for a type.

impl Message for FieldMaskRules

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 FieldMaskRules

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

impl StructuralPartialEq for FieldMaskRules