Struct BoolRules

pub struct BoolRules {
    pub const: Option<bool>,
    pub example: Vec<bool>,
}

BoolRules describes the rules applied to bool values. These rules may also be applied to the google.protobuf.BoolValue Well-Known-Type.

Fields

const: Option<bool>

const requires the field value to exactly match the specified boolean value. If the field value doesn’t match, an error message is generated.

message MyBool {
   // value must equal true
   bool value = 1 \[(buf.validate.field).bool.const = true\];
}

example: Vec<bool>

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 MyBool {
   bool value = 1 [
     (buf.validate.field).bool.example = 1,
     (buf.validate.field).bool.example = 2
   ];
}

Implementations

impl BoolRules

pub fn const(&self) -> bool

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

Trait Implementations

impl Clone for BoolRules

fn clone(&self) -> BoolRules

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for BoolRules

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

Formats the value using the given formatter.

impl Default for BoolRules

fn default() -> Self

Returns the “default value” for a type.

impl Message for BoolRules

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 BoolRules

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