Enum tonic::Code

pub enum Code {
    Ok = 0,
    Cancelled = 1,
    Unknown = 2,
    InvalidArgument = 3,
    DeadlineExceeded = 4,
    NotFound = 5,
    AlreadyExists = 6,
    PermissionDenied = 7,
    ResourceExhausted = 8,
    FailedPrecondition = 9,
    Aborted = 10,
    OutOfRange = 11,
    Unimplemented = 12,
    Internal = 13,
    Unavailable = 14,
    DataLoss = 15,
    Unauthenticated = 16,
}

gRPC status codes used by Status.

These variants match the gRPC status codes.

Variants

Ok = 0

The operation completed successfully.

Cancelled = 1

The operation was cancelled.

Unknown = 2

Unknown error.

InvalidArgument = 3

Client specified an invalid argument.

DeadlineExceeded = 4

Deadline expired before operation could complete.

NotFound = 5

Some requested entity was not found.

AlreadyExists = 6

Some entity that we attempted to create already exists.

PermissionDenied = 7

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

ResourceExhausted = 8

Some resource has been exhausted.

FailedPrecondition = 9

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

Aborted = 10

The operation was aborted.

OutOfRange = 11

Operation was attempted past the valid range.

Unimplemented = 12

Operation is not implemented or not supported.

Internal = 13

Internal error.

Unavailable = 14

The service is currently unavailable.

DataLoss = 15

Unrecoverable data loss or corruption.

Unauthenticated = 16

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 for Code

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

Tests for self and other values to be equal, and is used by ==.

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

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 StructuralPartialEq for Code