Enum Code 

#[repr(u8)]
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,
}

A gRPC status code — the integer carried in the grpc-status trailer.

The discriminants are the canonical gRPC code numbers, so as u8 and from_u8 move between the enum and its wire form. Ok (0) is the success code; every other variant is an error.

Variants

Ok = 0

Not an error; the RPC completed successfully.

Cancelled = 1

The operation was cancelled, typically by the caller.

Unknown = 2

An error whose cause doesn’t map to a more specific code. Also the code a missing or unparseable grpc-status resolves to.

InvalidArgument = 3

The client supplied an argument the server could not accept (as opposed to FailedPrecondition, this is independent of system state).

DeadlineExceeded = 4

The deadline expired before the operation could complete.

NotFound = 5

A requested entity was not found.

AlreadyExists = 6

An entity the client tried to create already exists.

PermissionDenied = 7

The caller is authenticated but lacks permission for this operation.

ResourceExhausted = 8

A resource has been exhausted — a quota, or perhaps the message-size limit.

FailedPrecondition = 9

The system is not in a state required for the operation (e.g. acting on a resource that must first be initialized).

Aborted = 10

The operation was aborted, often due to a concurrency conflict.

OutOfRange = 11

The operation was attempted past the valid range.

Unimplemented = 12

The operation is not implemented or not supported. Also the code a 404 from the transport maps to.

Internal = 13

An internal invariant was broken — something the implementation expected to hold did not.

Unavailable = 14

The service is unavailable, typically a transient condition the caller can retry with backoff.

DataLoss = 15

Unrecoverable data loss or corruption.

Unauthenticated = 16

The request lacks valid authentication credentials.

Implementations

impl Code

pub fn from_u8(n: u8) -> Option<Self>

Convert a wire byte to a Code, or None if it isn’t one of the 0–16 gRPC codes.

pub const fn as_u8(self) -> u8

The canonical gRPC code number, as written into the grpc-status trailer.

Trait Implementations

impl Clone for Code

fn clone(&self) -> Code

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for Code

impl Debug for Code

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

Formats the value using the given formatter.

impl Eq for Code

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