Struct tonic_types::pb::Status

pub struct Status {
    pub code: i32,
    pub message: String,
    pub details: Vec<Any>,
}

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

code: i32

The status code, which should be an enum value of [google.rpc.Code][google.rpc.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 [google.rpc.Status.details][google.rpc.Status.details] field, or localized by the client.

details: Vec<Any>

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() -> Self

Returns the “default value” for a type.

impl Message for Status

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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(&self, buf: &mut B) -> Result<(), EncodeError>

where B: BufMut, 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<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes an instance of the message from a buffer.

fn decode_length_delimited<B>(buf: B) -> Result<Self, DecodeError>

where B: Buf, Self: Default,

Decodes a length-delimited instance of the message from the buffer.

fn merge<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes an instance of the message from a buffer, and merges it into self.

fn merge_length_delimited<B>(&mut self, buf: B) -> Result<(), DecodeError>

where B: Buf, Self: Sized,

Decodes a length-delimited instance of the message from buffer, and merges it into self.

impl PartialEq for Status

fn eq(&self, other: &Status) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl RpcStatusExt for Status

fn check_error_details(&self) -> Result<ErrorDetails, DecodeError>

Can be used to check if the error details contained in pb::Status are malformed or not. Tries to get an ErrorDetails struct from a pb::Status. If some prost::DecodeError occurs, it will be returned. If not debugging, consider using RpcStatusExt::get_error_details or RpcStatusExt::get_error_details_vec.

fn get_error_details(&self) -> ErrorDetails

Get an ErrorDetails struct from pb::Status. If some prost::DecodeError occurs, an empty ErrorDetails struct will be returned.

fn check_error_details_vec(&self) -> Result<Vec<ErrorDetail>, DecodeError>

Can be used to check if the error details contained in pb::Status are malformed or not. Tries to get a vector of ErrorDetail enums from a pb::Status. If some prost::DecodeError occurs, it will be returned. If not debugging, consider using StatusExt::get_error_details_vec or StatusExt::get_error_details.

fn get_error_details_vec(&self) -> Vec<ErrorDetail>

Get a vector of ErrorDetail enums from pb::Status. If some prost::DecodeError occurs, an empty vector will be returned.

fn get_details_retry_info(&self) -> Option<RetryInfo>

Get first RetryInfo details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

fn get_details_debug_info(&self) -> Option<DebugInfo>

Get first DebugInfo details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

fn get_details_quota_failure(&self) -> Option<QuotaFailure>

Get first QuotaFailure details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

fn get_details_error_info(&self) -> Option<ErrorInfo>

Get first ErrorInfo details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

fn get_details_precondition_failure(&self) -> Option<PreconditionFailure>

Get first PreconditionFailure details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

fn get_details_bad_request(&self) -> Option<BadRequest>

Get first BadRequest details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

fn get_details_request_info(&self) -> Option<RequestInfo>

Get first RequestInfo details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

fn get_details_resource_info(&self) -> Option<ResourceInfo>

Get first ResourceInfo details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

fn get_details_help(&self) -> Option<Help>

Get first Help details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

fn get_details_localized_message(&self) -> Option<LocalizedMessage>

Get first LocalizedMessage details found on pb::Status, if any. If some prost::DecodeError occurs, returns None.

impl StructuralPartialEq for Status