Struct Status 

#[non_exhaustive]
pub struct Status {
    pub code: Option<i32>,
    pub details: Vec<Any>,
    pub message: Option<String>,
    /* private fields */
}

Available on crate features addresses or autoscalers or backend-buckets or backend-services or cross-site-networks or disks or external-vpn-gateways or firewall-policies or firewalls or forwarding-rules or future-reservations or global-addresses or global-forwarding-rules or global-network-endpoint-groups or global-operations or global-organization-operations or global-public-delegated-prefixes or health-checks or http-health-checks or https-health-checks or images or instance-group-manager-resize-requests or instance-group-managers or instance-groups or instance-settings or instance-templates or instances or instant-snapshots or interconnect-attachment-groups or interconnect-attachments or interconnect-groups or interconnects or licenses or machine-images or network-attachments or network-edge-security-services or network-endpoint-groups or network-firewall-policies or networks or node-groups or node-templates or organization-security-policies or packet-mirrorings or preview-features or projects or public-advertised-prefixes or public-delegated-prefixes or region-autoscalers or region-backend-services or region-commitments or region-disks or region-health-check-services or region-health-checks or region-instance-group-managers or region-instance-groups or region-instance-templates or region-instances or region-instant-snapshots or region-network-endpoint-groups or region-network-firewall-policies or region-notification-endpoints or region-operations or region-security-policies or region-ssl-certificates or region-ssl-policies or region-target-http-proxies or region-target-https-proxies or region-target-tcp-proxies or region-url-maps or reservation-blocks or reservation-slots or reservation-sub-blocks or reservations or resource-policies or routers or routes or security-policies or service-attachments or snapshot-settings or snapshots or ssl-certificates or ssl-policies or storage-pools or subnetworks or target-grpc-proxies or target-http-proxies or target-https-proxies or target-instances or target-pools or target-ssl-proxies or target-tcp-proxies or target-vpn-gateways or url-maps or vpn-gateways or vpn-tunnels or wire-groups or zone-operations only.

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. It is used by gRPC. Each Status message contains three pieces of data: error code, error message, and error details.

You can find out more about this error model and how to work with it in the API Design Guide.

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.

code: Option<i32>

The status code, which should be an enum value of google.rpc.Code.

details: Vec<Any>

A list of messages that carry the error details. There is a common set of message types for APIs to use.

message: Option<String>

A developer-facing error message, which should be in English. Any user-facing error message should be localized and sent in the google.rpc.Status.details field, or localized by the client.

Implementations

impl Status

pub fn new() -> Self

pub fn set_code<T>(self, v: T) -> Self

where T: Into<i32>,

Sets the value of code.

Example

let x = Status::new().set_code(42);

pub fn set_or_clear_code<T>(self, v: Option<T>) -> Self

where T: Into<i32>,

Sets or clears the value of code.

Example

let x = Status::new().set_or_clear_code(Some(42));
let x = Status::new().set_or_clear_code(None::<i32>);

pub fn set_details<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Any>,

Sets the value of details.

Example

use wkt::Any;
let x = Status::new()
    .set_details([
        Any::default()/* use setters */,
        Any::default()/* use (different) setters */,
    ]);

pub fn set_message<T>(self, v: T) -> Self

where T: Into<String>,

Sets the value of message.

Example

let x = Status::new().set_message("example");

pub fn set_or_clear_message<T>(self, v: Option<T>) -> Self

where T: Into<String>,

Sets or clears the value of message.

Example

let x = Status::new().set_or_clear_message(Some("example"));
let x = Status::new().set_or_clear_message(None::<String>);

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Status

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

Formats the value using the given formatter.

impl Default for Status

fn default() -> Status

Returns the “default value” for a type.

impl Message for Status

fn typename() -> &'static str

The typename of this message.

impl PartialEq for Status

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