Struct TonicStatusWrapper

pub struct TonicStatusWrapper {
    inner: Status,
    client_side_service_name: Option<Cow<'static, str>>,
}

A wrapper of tonic::Status that provides better error message and extracts the source chain from the details field.

Fields

inner: Status

client_side_service_name: Option<Cow<'static, str>>

Optional service name from the client side.

Explanation

tonic::Status is used for both client and server side. When the error is created on the server side, we encourage developers to provide the service name with ToTonicStatus::to_status, so that the info can be included in the HTTP response and then extracted by the client side (in TonicStatusWrapper::new).

However, if there’s something wrong with the server side and the error is directly created on the client side, the approach above is not applicable. In this case, the caller should set a “client side” service name to provide better error message. This is achieved by TonicStatusWrapperExt::with_client_side_service_name.

Implementations

impl TonicStatusWrapper

pub fn new(status: Status) -> Self

Create a new TonicStatusWrapper from the given tonic::Status and extract the source chain from its details field.

pub fn inner(&self) -> &Status

Returns the reference to the inner tonic::Status.

pub fn into_inner(self) -> Status

Consumes self and returns the inner tonic::Status.

Trait Implementations

impl Debug for TonicStatusWrapper

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

Formats the value using the given formatter.

impl Display for TonicStatusWrapper

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

Formats the value using the given formatter.

impl Error for TonicStatusWrapper

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

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

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.

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

impl From<Status> for TonicStatusWrapper

fn from(status: Status) -> Self

Converts to this type from the input type.