Struct tonic::Status

source ·
pub struct Status { /* private fields */ }
Expand description

A gRPC status describing the result of an RPC call.

Values can be created using the new function or one of the specialized associated functions.

let status1 = Status::new(Code::InvalidArgument, "name is invalid");
let status2 = Status::invalid_argument("name is invalid");

assert_eq!(status1.code(), Code::InvalidArgument);
assert_eq!(status1.code(), status2.code());

Implementations§

source§

impl Status

source

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

Create a new Status with the associated code and message.

source

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

The operation completed successfully.

source

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

The operation was cancelled (typically by the caller).

source

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

Unknown error. An example of where this error may be returned is if a Status value received from another address space belongs to an error-space that is not known in this address space. Also errors raised by APIs that do not return enough error information may be converted to this error.

source

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

Client specified an invalid argument. Note that this differs from FailedPrecondition. InvalidArgument indicates arguments that are problematic regardless of the state of the system (e.g., a malformed file name).

source

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

Deadline expired before operation could complete. For operations that change the state of the system, this error may be returned even if the operation has completed successfully. For example, a successful response from a server could have been delayed long enough for the deadline to expire.

source

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

Some requested entity (e.g., file or directory) was not found.

source

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

Some entity that we attempted to create (e.g., file or directory) already exists.

source

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

The caller does not have permission to execute the specified operation. PermissionDenied must not be used for rejections caused by exhausting some resource (use ResourceExhausted instead for those errors). PermissionDenied must not be used if the caller cannot be identified (use Unauthenticated instead for those errors).

source

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

Some resource has been exhausted, perhaps a per-user quota, or perhaps the entire file system is out of space.

source

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

Operation was rejected because the system is not in a state required for the operation’s execution. For example, directory to be deleted may be non-empty, an rmdir operation is applied to a non-directory, etc.

A litmus test that may help a service implementor in deciding between FailedPrecondition, Aborted, and Unavailable: (a) Use Unavailable if the client can retry just the failing call. (b) Use Aborted if the client should retry at a higher-level (e.g., restarting a read-modify-write sequence). (c) Use FailedPrecondition if the client should not retry until the system state has been explicitly fixed. E.g., if an “rmdir” fails because the directory is non-empty, FailedPrecondition should be returned since the client should not retry unless they have first fixed up the directory by deleting files from it.

source

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

The operation was aborted, typically due to a concurrency issue like sequencer check failures, transaction aborts, etc.

See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.

source

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

Operation was attempted past the valid range. E.g., seeking or reading past end of file.

Unlike InvalidArgument, this error indicates a problem that may be fixed if the system state changes. For example, a 32-bit file system will generate InvalidArgument if asked to read at an offset that is not in the range [0,2^32-1], but it will generate OutOfRange` if asked to read from an offset past the current file size.

There is a fair bit of overlap between FailedPrecondition and OutOfRange. We recommend using OutOfRange (the more specific error) when it applies so that callers who are iterating through a space can easily look for an OutOfRange error to detect when they are done.

source

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

Operation is not implemented or not supported/enabled in this service.

source

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

Internal errors. Means some invariants expected by underlying system has been broken. If you see one of these errors, something is very broken.

source

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

The service is currently unavailable. This is a most likely a transient condition and may be corrected by retrying with a back-off.

See litmus test above for deciding between FailedPrecondition, Aborted, and Unavailable.

source

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

Unrecoverable data loss or corruption.

source

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

The request does not have valid authentication credentials for the operation.

source

pub fn from_error(err: Box<dyn Error + Send + Sync + 'static>) -> Status

Create a Status from various types of Error.

Inspects the error source chain for recognizable errors, including statuses, HTTP2, and hyper, and attempts to maps them to a Status, or else returns an Unknown Status.

source

pub fn try_from_error( err: Box<dyn Error + Send + Sync + 'static>, ) -> Result<Status, Box<dyn Error + Send + Sync + 'static>>

Create a Status from various types of Error.

Returns the error if a status could not be created.

§Downcast stability

This function does not provide any stability guarantees around how it will downcast errors into status codes.

source

pub fn from_header_map(header_map: &HeaderMap) -> Option<Status>

Extract a Status from a hyper HeaderMap.

source

pub fn code(&self) -> Code

Get the gRPC Code of this Status.

source

pub fn message(&self) -> &str

Get the text error message of this Status.

source

pub fn details(&self) -> &[u8]

Get the opaque error details of this Status.

source

pub fn metadata(&self) -> &MetadataMap

Get a reference to the custom metadata.

source

pub fn metadata_mut(&mut self) -> &mut MetadataMap

Get a mutable reference to the custom metadata.

source

pub fn add_header(&self, header_map: &mut HeaderMap) -> Result<(), Self>

Add headers from this Status into header_map.

source

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

Create a new Status with the associated code, message, and binary details field.

source

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

Create a new Status with the associated code, message, and custom metadata

source

pub fn with_details_and_metadata( code: Code, message: impl Into<String>, details: Bytes, metadata: MetadataMap, ) -> Status

Create a new Status with the associated code, message, binary details field and custom metadata

source

pub fn set_source( &mut self, source: Arc<dyn Error + Send + Sync + 'static>, ) -> &mut Status

Add a source error to this status.

source

pub fn to_http(self) -> Response<BoxBody>

Build an http::Response from the given Status.

Trait Implementations§

source§

impl Clone for Status

source§

fn clone(&self) -> Status

Returns a copy of the value. Read more
1.0.0 · source§

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source. Read more
source§

impl Debug for Status

source§

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

Formats the value using the given formatter. Read more
source§

impl Display for Status

source§

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

Formats the value using the given formatter. Read more
source§

impl Error for Status

source§

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

Returns the lower-level source of this error, if any. Read more
1.0.0 · source§

fn description(&self) -> &str

👎Deprecated since 1.42.0: use the Display impl or to_string()
1.0.0 · source§

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

👎Deprecated since 1.33.0: replaced by Error::source, which can support downcasting
source§

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

🔬This is a nightly-only experimental API. (error_generic_member_access #99301)
Provides type-based access to context intended for error reports. Read more
source§

impl From<Error> for Status

source§

fn from(err: Error) -> Self

Converts to this type from the input type.
source§

impl From<Error> for Status

source§

fn from(err: Error) -> Self

Converts to this type from the input type.
source§

impl From<Status> for Error

source§

fn from(status: Status) -> Self

Converts to this type from the input type.

Auto Trait Implementations§

§

impl !Freeze for Status

§

impl !RefUnwindSafe for Status

§

impl Send for Status

§

impl Sync for Status

§

impl Unpin for Status

§

impl !UnwindSafe for Status

Blanket Implementations§

source§

impl<T> Any for T
where T: 'static + ?Sized,

source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
source§

impl<T> Borrow<T> for T
where T: ?Sized,

source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
source§

impl<T> CloneToUninit for T
where T: Clone,

source§

unsafe fn clone_to_uninit(&self, dst: *mut T)

🔬This is a nightly-only experimental API. (clone_to_uninit #126799)
Performs copy-assignment from self to dst. Read more
source§

impl<T> From<T> for T

source§

fn from(t: T) -> T

Returns the argument unchanged.

§

impl<T> FromRef<T> for T
where T: Clone,

§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
source§

impl<T> Instrument for T

source§

fn instrument(self, span: Span) -> Instrumented<Self>

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
source§

fn in_current_span(self) -> Instrumented<Self>

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
source§

impl<T, U> Into<U> for T
where U: From<T>,

source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

source§

impl<T> IntoRequest<T> for T

source§

fn into_request(self) -> Request<T>

Wrap the input message T in a tonic::Request
source§

impl<T> ToOwned for T
where T: Clone,

source§

type Owned = T

The resulting type after obtaining ownership.
source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
source§

impl<T> ToString for T
where T: Display + ?Sized,

source§

default fn to_string(&self) -> String

Converts the given value to a String. Read more
source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

source§

type Error = Infallible

The type returned in the event of a conversion error.
source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.
source§

impl<V, T> VZip<V> for T
where V: MultiLane<T>,

source§

fn vzip(self) -> V

source§

impl<T> WithSubscriber for T

source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self>
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
source§

fn with_current_subscriber(self) -> WithDispatch<Self>

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more