Enum Ignore 

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

Available on crate feature protovalidate only.

Specifies how FieldRules.ignore behaves, depending on the field’s value, and whether the field tracks presence.

Variants

Unspecified = 0

Ignore rules if the field tracks presence and is unset. This is the default behavior.

In proto3, only message fields, members of a Protobuf oneof, and fields with the optional label track presence. Consequently, the following fields are always validated, whether a value is set or not:

syntax="proto3";

message RulesApply {
   string email = 1 [
     (buf.validate.field).string.email = true
   ];
   int32 age = 2 [
     (buf.validate.field).int32.gt = 0
   ];
   repeated string labels = 3 [
     (buf.validate.field).repeated.min_items = 1
   ];
}

In contrast, the following fields track presence, and are only validated if a value is set:

syntax="proto3";

message RulesApplyIfSet {
   optional string email = 1 [
     (buf.validate.field).string.email = true
   ];
   oneof ref {
     string reference = 2 [
       (buf.validate.field).string.uuid = true
     ];
     string name = 3 [
       (buf.validate.field).string.min_len = 4
     ];
   }
   SomeMessage msg = 4 [
     (buf.validate.field).cel = {/* ... */}
   ];
}

To ensure that such a field is set, add the required rule.

To learn which fields track presence, see the Field Presence cheat sheet.

IfZeroValue = 1

Ignore rules if the field is unset, or set to the zero value.

The zero value depends on the field type:

• For strings, the zero value is the empty string.
• For bytes, the zero value is empty bytes.
• For bool, the zero value is false.
• For numeric types, the zero value is zero.
• For enums, the zero value is the first defined enum value.
• For repeated fields, the zero is an empty list.
• For map fields, the zero is an empty map.
• For message fields, absence of the message (typically a null-value) is considered zero value.

For fields that track presence (e.g. adding the optional label in proto3), this a no-op and behavior is the same as the default IGNORE_UNSPECIFIED.

Always = 3

Always ignore rules, including the required rule.

This is useful for ignoring the rules of a referenced message, or to temporarily ignore rules during development.

message MyMessage {
   // The field's rules will always be ignored, including any validations
   // 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 ToTokens for Ignore

Available on crate feature totokens only.

fn to_tokens(&self, tokens: &mut TokenStream)

Write self to the given TokenStream.

fn to_token_stream(&self) -> TokenStream

Convert self directly into a TokenStream object.

fn into_token_stream(self) -> TokenStream

where Self: Sized,

Convert self directly into a TokenStream object.

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