Struct Status 

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

Available on crate feature ttrpc only.

Fields

code: i32

The status code, which should be an enum value of 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 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.

Implementations

impl Status

pub fn code(&self) -> Code

Returns the enum value of code, or the default if the field is set to an invalid enum value.

pub fn set_code(&mut self, value: Code)

Sets code to the provided enum value.

impl Status

pub fn new(code: Code, message: impl Into<String>) -> Status

pub fn cancelled(message: impl Into<String>) -> Status

pub fn unknown(message: impl Into<String>) -> Status

pub fn invalid_argument(message: impl Into<String>) -> Status

pub fn deadline_exceeded(message: impl Into<String>) -> Status

pub fn not_found(message: impl Into<String>) -> Status

pub fn already_exists(message: impl Into<String>) -> Status

pub fn permission_denied(message: impl Into<String>) -> Status

pub fn unauthenticated(message: impl Into<String>) -> Status

pub fn resource_exhausted(message: impl Into<String>) -> Status

pub fn failed_precondition(message: impl Into<String>) -> Status

pub fn aborted(message: impl Into<String>) -> Status

pub fn out_of_range(message: impl Into<String>) -> Status

pub fn unimplemented(message: impl Into<String>) -> Status

pub fn internal(message: impl Into<String>) -> Status

pub fn unavailable(message: impl Into<String>) -> Status

pub fn data_loss(message: impl Into<String>) -> Status

pub fn from_error(err: impl Error) -> Status

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

Formats the value using the given formatter.

impl Default for Status

fn default() -> Status

Returns the “default value” for a type.

impl Display for Status

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

Formats the value using the given formatter.

impl Error for Status

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<Error> for Status

fn from(error: Error) -> Status

Converts to this type from the input 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(&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 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