Struct Violation

pub struct Violation {
    pub type: String,
    pub subject: String,
    pub description: String,
}

A message type used to describe a single precondition failure.

Fields

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 const fn const_default() -> Violation

pub fn type_mut(&mut self) -> &mut String

Returns a mutable reference to r#type. If the field is unset, it is first initialized with the default value.

pub fn set_type<T>(&mut self, field: T)

where T: Into<String>,

Sets r#type with the provided value.

pub fn with_type<T>(self, field: T) -> Violation

where T: Into<String>,

Sets r#type with the provided value.

pub fn subject_mut(&mut self) -> &mut String

Returns a mutable reference to subject. If the field is unset, it is first initialized with the default value.

pub fn set_subject<T>(&mut self, field: T)

where T: Into<String>,

Sets subject with the provided value.

pub fn with_subject<T>(self, field: T) -> Violation

where T: Into<String>,

Sets subject with the provided value.

pub fn description_mut(&mut self) -> &mut String

Returns a mutable reference to description. If the field is unset, it is first initialized with the default value.

pub fn set_description<T>(&mut self, field: T)

where T: Into<String>,

Sets description with the provided value.

pub fn with_description<T>(self, field: T) -> Violation

where T: Into<String>,

Sets description with the provided value.

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<(), Error>

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

fn deserialize<D>( deserializer: D, ) -> Result<Violation, <D as Deserializer<'de>>::Error>

where D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Message for Violation

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 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 as Serializer>::Ok, <S as Serializer>::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for Violation