Enum tonic::Code

pub enum Code {
    Ok,
    Cancelled,
    Unknown,
    InvalidArgument,
    DeadlineExceeded,
    NotFound,
    AlreadyExists,
    PermissionDenied,
    ResourceExhausted,
    FailedPrecondition,
    Aborted,
    OutOfRange,
    Unimplemented,
    Internal,
    Unavailable,
    DataLoss,
    Unauthenticated,
}

gRPC status codes used by Status.

These variants match the gRPC status codes.

Variants

Ok

The operation completed successfully.

Cancelled

The operation was cancelled.

Unknown

Unknown error.

InvalidArgument

Client specified an invalid argument.

DeadlineExceeded

Deadline expired before operation could complete.

NotFound

Some requested entity was not found.

AlreadyExists

Some entity that we attempted to create already exists.

PermissionDenied

The caller does not have permission to execute the specified operation.

ResourceExhausted

Some resource has been exhausted.

FailedPrecondition

The system is not in a state required for the operation’s execution.

Aborted

The operation was aborted.

OutOfRange

Operation was attempted past the valid range.

Unimplemented

Operation is not implemented or not supported.

Internal

Internal error.

Unavailable

The service is currently unavailable.

DataLoss

Unrecoverable data loss or corruption.

Unauthenticated

The request does not have valid authentication credentials

Implementations

impl Code

pub fn description(&self) -> &'static str

Get description of this Code.

fn make_grpc_request() -> tonic::Code {
    // ...
    tonic::Code::Ok
}
let code = make_grpc_request();
println!("Operation completed. Human readable description: {}", code.description());

If you only need description in println, format, log and other formatting contexts, you may want to use Display impl for Code instead.

impl Code

pub fn from_i32(i: i32) -> Code

Get the Code that represents the integer, if known.

If not known, returns Code::Unknown (surprise!).

pub fn from_bytes(bytes: &[u8]) -> Code

Convert the string representation of a Code (as stored, for example, in the grpc-status header in a response) into a Code. Returns Code::Unknown if the code string is not a valid gRPC status code.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Code

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

Formats the value using the given formatter.

impl Display for Code

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

Formats the value using the given formatter.

impl From<Code> for i32

fn from(code: Code) -> i32

Converts to this type from the input type.

impl From<i32> for Code

fn from(i: i32) -> Self

Converts to this type from the input type.

impl Hash for Code

fn hash<__H: Hasher>(&self, state: &mut __H)

Feeds this value into the given Hasher.

fn hash_slice<H>(data: &[Self], state: &mut H)where H: Hasher, Self: Sized,

Feeds a slice of this type into the given Hasher.

impl PartialEq<Code> for Code

fn eq(&self, other: &Code) -> bool

This method tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

This method tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl Copy for Code

impl Eq for Code

impl StructuralEq for Code

impl StructuralPartialEq for Code