Struct FieldViolation

#[non_exhaustive]
pub struct FieldViolation {
    pub field: String,
    pub description: String,
    pub reason: String,
    pub localized_message: Option<LocalizedMessage>,
}

A message type used to describe a single bad request field.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

field: String

A path that leads to a field in the request body. The value will be a sequence of dot-separated identifiers that identify a protocol buffer field.

Consider the following:

message CreateContactRequest {
  message EmailAddress {
    enum Type {
      TYPE_UNSPECIFIED = 0;
      HOME = 1;
      WORK = 2;
    }

    optional string email = 1;
    repeated EmailType type = 2;
  }

  string full_name = 1;
  repeated EmailAddress email_addresses = 2;
}

In this example, in proto field could take one of the following values:

• full_name for a violation in the full_name value
• email_addresses[1].email for a violation in the email field of the first email_addresses message
• email_addresses[3].type[2] for a violation in the second type value in the third email_addresses message.

In JSON, the same values are represented as:

• fullName for a violation in the fullName value
• emailAddresses[1].email for a violation in the email field of the first emailAddresses message
• emailAddresses[3].type[2] for a violation in the second type value in the third emailAddresses message.

description: String

A description of why the request element is bad.

reason: String

The reason of the field-level error. This is a constant value that identifies the proximate cause of the field-level error. It should uniquely identify the type of the FieldViolation within the scope of the google.rpc.ErrorInfo.domain. This should be at most 63 characters and match a regular expression of [A-Z][A-Z0-9_]+[A-Z0-9], which represents UPPER_SNAKE_CASE.

localized_message: Option<LocalizedMessage>

Provides a localized error message for field-level errors that is safe to return to the API consumer.

Implementations

impl FieldViolation

pub fn set_field<T: Into<String>>(self, v: T) -> Self

Sets the value of field.

pub fn set_description<T: Into<String>>(self, v: T) -> Self

Sets the value of description.

pub fn set_reason<T: Into<String>>(self, v: T) -> Self

Sets the value of reason.

pub fn set_localized_message<T: Into<Option<LocalizedMessage>>>( self, v: T, ) -> Self

Sets the value of localized_message.

Trait Implementations

impl Clone for FieldViolation

fn clone(&self) -> FieldViolation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for FieldViolation

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

Formats the value using the given formatter.

impl Default for FieldViolation

fn default() -> FieldViolation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for FieldViolation

where FieldViolation: Default,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for FieldViolation

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for FieldViolation