Enum Ignore

#[repr(i32)]
pub enum Ignore {
    Unspecified = 0,
    IfUnpopulated = 1,
    IfDefaultValue = 2,
    Always = 3,
}

Specifies how FieldRules.ignore behaves. See the documentation for FieldRules.required for definitions of “populated” and “nullable”.

Variants

Unspecified = 0

Validation is only skipped if it’s an unpopulated nullable fields.

syntax="proto3";

message Request {
   // The uri rule applies to any value, including the empty string.
   string foo = 1 [
     (buf.validate.field).string.uri = true
   ];

   // The uri rule only applies if the field is set, including if it's
   // set to the empty string.
   optional string bar = 2 [
     (buf.validate.field).string.uri = true
   ];

   // The min_items rule always applies, even if the list is empty.
   repeated string baz = 3 [
     (buf.validate.field).repeated.min_items = 3
   ];

   // The custom CEL rule applies only if the field is set, including if
   // it's the "zero" value of that message.
   SomeMessage quux = 4 [
     (buf.validate.field).cel = {/* ... */}
   ];
}

IfUnpopulated = 1

Validation is skipped if the field is unpopulated. This rule is redundant if the field is already nullable.

syntax="proto3

message Request {
   // The uri rule applies only if the value is not the empty string.
   string foo = 1 [
     (buf.validate.field).string.uri = true,
     (buf.validate.field).ignore = IGNORE_IF_UNPOPULATED
   ];

   // IGNORE_IF_UNPOPULATED is equivalent to IGNORE_UNSPECIFIED in this
   // case: the uri rule only applies if the field is set, including if
   // it's set to the empty string.
   optional string bar = 2 [
     (buf.validate.field).string.uri = true,
     (buf.validate.field).ignore = IGNORE_IF_UNPOPULATED
   ];

   // The min_items rule only applies if the list has at least one item.
   repeated string baz = 3 [
     (buf.validate.field).repeated.min_items = 3,
     (buf.validate.field).ignore = IGNORE_IF_UNPOPULATED
   ];

   // IGNORE_IF_UNPOPULATED is equivalent to IGNORE_UNSPECIFIED in this
   // case: the custom CEL rule applies only if the field is set, including
   // if it's the "zero" value of that message.
   SomeMessage quux = 4 [
     (buf.validate.field).cel = {/* ... */},
     (buf.validate.field).ignore = IGNORE_IF_UNPOPULATED
   ];
}

IfDefaultValue = 2

Validation is skipped if the field is unpopulated or if it is a nullable field populated with its default value. This is typically the zero or empty value, but proto2 scalars support custom defaults. For messages, the default is a non-null message with all its fields unpopulated.

syntax="proto3

message Request {
   // IGNORE_IF_DEFAULT_VALUE is equivalent to IGNORE_IF_UNPOPULATED in
   // this case; the uri rule applies only if the value is not the empty
   // string.
   string foo = 1 [
     (buf.validate.field).string.uri = true,
     (buf.validate.field).ignore = IGNORE_IF_DEFAULT_VALUE
   ];

   // The uri rule only applies if the field is set to a value other than
   // the empty string.
   optional string bar = 2 [
     (buf.validate.field).string.uri = true,
     (buf.validate.field).ignore = IGNORE_IF_DEFAULT_VALUE
   ];

   // IGNORE_IF_DEFAULT_VALUE is equivalent to IGNORE_IF_UNPOPULATED in
   // this case; the min_items rule only applies if the list has at least
   // one item.
   repeated string baz = 3 [
     (buf.validate.field).repeated.min_items = 3,
     (buf.validate.field).ignore = IGNORE_IF_DEFAULT_VALUE
   ];

   // The custom CEL rule only applies if the field is set to a value other
   // than an empty message (i.e., fields are unpopulated).
   SomeMessage quux = 4 [
     (buf.validate.field).cel = {/* ... */},
     (buf.validate.field).ignore = IGNORE_IF_DEFAULT_VALUE
   ];
}

This rule is affected by proto2 custom default values:

syntax="proto2";

message Request {
   // The gt rule only applies if the field is set and it's value is not
   the default (i.e., not -42). The rule even applies if the field is set
   to zero since the default value differs.
   optional int32 value = 1 [
     default = -42,
     (buf.validate.field).int32.gt = 0,
     (buf.validate.field).ignore = IGNORE_IF_DEFAULT_VALUE
   ];
}

Always = 3

The validation rules of this field will be skipped and not evaluated. This is useful for situations that necessitate turning off the rules of a field containing a message that may not make sense in the current context, or to temporarily disable rules during development.

message MyMessage {
   // The field's rules will always be ignored, including any validation's
   // on value's fields.
   MyOtherMessage value = 1 [
     (buf.validate.field).ignore = IGNORE_ALWAYS];
}

Implementations

impl Ignore

pub fn is_valid(value: i32) -> bool

Returns true if value is a variant of Ignore.

pub fn from_i32(value: i32) -> Option<Ignore>

👎Deprecated: Use the TryFrom<i32> implementation instead

Converts an i32 to a Ignore, or None if value is not a valid variant.

impl Ignore

pub fn as_str_name(&self) -> &'static str

String value of the enum field names used in the ProtoBuf definition.

The values are not transformed in any way and thus are considered stable (if the ProtoBuf definition does not change) and safe for programmatic use.

pub fn from_str_name(value: &str) -> Option<Self>

Creates an enum from field names used in the ProtoBuf definition.

Trait Implementations

impl Clone for Ignore

fn clone(&self) -> Ignore

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Ignore

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

Formats the value using the given formatter.

impl Default for Ignore

fn default() -> Ignore

Returns the “default value” for a type.

impl From<Ignore> for i32

fn from(value: Ignore) -> i32

Converts to this type from the input type.

impl Hash for Ignore

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)

where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl Ord for Ignore

fn cmp(&self, other: &Ignore) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Ignore

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

fn partial_cmp(&self, other: &Ignore) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

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

Tests less than (for self and other) and is used by the < operator.

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

Tests less than or equal to (for self and other) and is used by the <= operator.

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

Tests greater than (for self and other) and is used by the > operator.

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

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl TryFrom<i32> for Ignore

type Error = UnknownEnumValue

The type returned in the event of a conversion error.

fn try_from(value: i32) -> Result<Ignore, UnknownEnumValue>

Performs the conversion.

impl Copy for Ignore

impl Eq for Ignore

impl StructuralPartialEq for Ignore