Struct OneofRules 

pub struct OneofRules {
    pub required: Option<bool>,
}

The OneofRules message type enables you to manage rules for oneof fields in your protobuf messages.

Fields

required: Option<bool>

If required is true, exactly one field of the oneof must be present. A validation error is returned if no fields in the oneof are present. The field itself may still be a default value; further rules should be placed on the fields themselves to ensure they are valid values, such as min_len or gt.

message MyMessage {
   oneof value {
     // Either `a` or `b` must be set. If `a` is set, it must also be
     // non-empty; whereas if `b` is set, it can still be an empty string.
     option (buf.validate.oneof).required = true;
     string a = 1 \[(buf.validate.field).string.min_len = 1\];
     string b = 2;
   }
}

Implementations

impl OneofRules

pub fn required(&self) -> bool

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

Trait Implementations

impl Clone for OneofRules

fn clone(&self) -> OneofRules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OneofRules

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

Formats the value using the given formatter.

impl Default for OneofRules

fn default() -> Self

Returns the “default value” for a type.

impl Message for OneofRules

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 OneofRules

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

impl StructuralPartialEq for OneofRules