Struct Status 

pub struct Status {
    pub code: Code,
    pub message: String,
    pub metadata: Metadata,
}

The outcome of an RPC: a Code, a human-readable message, and any trailing Metadata.

This is both the error type returned from service methods and the value parsed back out of a response’s grpc-status trailers. It implements std::error::Error, so ? works in any method returning Result<_, Status>. Build one with new or a code-named constructor such as not_found.

Fields

code: Code

The gRPC status code.

message: String

A human-readable description. Percent-encoded on the wire so it can carry arbitrary UTF-8.

metadata: Metadata

Trailing metadata sent alongside the status.

Implementations

impl Status

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

Construct a Status with the given code and message, and empty metadata. The code-named constructors (not_found, internal, …) are usually more convenient.

pub fn ok() -> Self

The success status: code Ok, empty message, empty metadata.

pub fn is_ok(&self) -> bool

Whether this status is the success code.

pub fn with_metadata(self, metadata: Metadata) -> Self

Attach trailing metadata. Carried in the grpc-status trailers alongside grpc-message.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

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

Construct a Status with this code and the given message, and empty metadata.

pub fn into_trailers(self) -> Headers

Serialize into a fresh Headers, suitable for use as response trailers. See write_into for the header layout.

pub fn write_into(&self, headers: &mut Headers)

Write grpc-status (and, when non-empty, the percent-encoded grpc-message) plus any trailing metadata into headers.

pub fn from_trailers(headers: &Headers) -> Result<(), Self>

Read a Status from response trailers (or trailer-only response headers). Returns Ok(()) for grpc-status: 0, Err(Status) otherwise. Missing grpc-status is treated as Unknown per spec. On the Err path the returned Status carries any custom trailing metadata extracted from the same headers.

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 Display for Status

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

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.