Struct Violation

#[non_exhaustive]
pub struct Violation {
    pub type: String,
    pub subject: String,
    pub description: String,
}

A message type used to describe a single precondition failure.

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.

type: String

The type of PreconditionFailure. We recommend using a service-specific enum type to define the supported precondition violation subjects. For example, “TOS” for “Terms of Service violation”.

subject: String

The subject, relative to the type, that failed. For example, “google.com/cloud” relative to the “TOS” type would indicate which terms of service is being referenced.

description: String

A description of how the precondition failed. Developers can use this description to understand how to fix the failure.

For example: “Terms of service not accepted”.

Implementations

impl Violation

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

Sets the value of r#type.

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

Sets the value of subject.

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

Sets the value of description.

Trait Implementations

impl Clone for Violation

fn clone(&self) -> Violation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Violation

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

Formats the value using the given formatter.

impl Default for Violation

fn default() -> Violation

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for Violation

where Violation: Default,

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Violation

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Violation

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

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 Violation