Struct Status

#[non_exhaustive]
pub struct Status {
    pub code: i32,
    pub message: String,
    pub status: Option<String>,
    pub details: Vec<StatusDetails>,
}

The Status type defines a logical error model that is suitable for different programming environments, including REST APIs and RPC APIs. 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: i32

The status code.

When using a HTTP transport this is the HTTP status code. When using gRPC, this is one of the values enumerated in Code.

message: String

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

status: Option<String>

The underlying google.rpc.Status.code, as a string.

When serialized over JSON, status messages include both the HTTP status code (in the code field), and the status Code as a string.

details: Vec<StatusDetails>

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

Trait Implementations

impl Clone for Status

fn clone(&self) -> Status

Returns a copy 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<'de> Deserialize<'de> for Status

where Status: 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 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 Serialize for Status

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl TryFrom<&Bytes> for Status

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &Bytes) -> Result<Self, Self::Error>

Performs the conversion.

impl TryFrom<&HttpError> for Status

type Error = Error

The type returned in the event of a conversion error.

fn try_from(value: &HttpError) -> Result<Self, Self::Error>

Performs the conversion.

impl StructuralPartialEq for Status