Struct tonic::Status[][src]

pub struct Status { /* fields omitted */ }
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

Create a new Status with the associated code and message.

The operation completed successfully.

The operation was cancelled (typically by the caller).

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.

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).

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.

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

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

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).

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

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.

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.

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.

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

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

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.

Unrecoverable data loss or corruption.

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

Extract a Status from a hyper HeaderMap.

Get the gRPC Code of this Status.

Get the text error message of this Status.

Get the opaque error details of this Status.

Get a reference to the custom metadata.

Get a mutable reference to the custom metadata.

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

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

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

Build an http::Response from the given Status.

Trait Implementations

Formats the value using the given formatter. Read more

Formats the value using the given formatter. Read more

The lower-level source of this error, if any. Read more

🔬 This is a nightly-only experimental API. (backtrace #53487)

Returns a stack backtrace, if available, of where this error occurred. Read more

👎 Deprecated since 1.42.0:

use the Display impl or to_string()

👎 Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

Performs the conversion.

Performs the conversion.

Performs the conversion.

Auto Trait Implementations

Blanket Implementations

Gets the TypeId of self. Read more

Immutably borrows from an owned value. Read more

Mutably borrows from an owned value. Read more

Performs the conversion.

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

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

Performs the conversion.

Converts the given value to a String. Read more

The type returned in the event of a conversion error.

Performs the conversion.

The type returned in the event of a conversion error.

Performs the conversion.

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

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