Struct FieldViolation 

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

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 has_field(&self, field: &str) -> bool

Available on crate feature rpc only.

Returns true if the field matches the given value.

pub fn has_description(&self, description: &str) -> bool

Available on crate feature rpc only.

Returns true if the description matches the given value.

pub fn has_reason(&self, reason: &str) -> bool

Available on crate feature rpc only.

Returns true if the reason matches the given value.

Trait Implementations

impl Clone for FieldViolation

fn clone(&self) -> FieldViolation

Returns a duplicate 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() -> Self

Returns the “default value” for a type.

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

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<FieldViolation> for Value

Available on crate features cel and rpc only.

fn from(value: FieldViolation) -> Self

Converts to this type from the input type.

impl Hash for FieldViolation

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 Message for FieldViolation

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 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 Eq for FieldViolation

impl StructuralPartialEq for FieldViolation