Enum TwirpErrorCode

#[non_exhaustive]
pub enum TwirpErrorCode {
    Canceled,
    Unknown,
    InvalidArgument,
    Malformed,
    DeadlineExceeded,
    NotFound,
    BadRoute,
    AlreadyExists,
    PermissionDenied,
    Unauthenticated,
    ResourceExhausted,
    FailedPrecondition,
    Aborted,
    OutOfRange,
    Unimplemented,
    Internal,
    Unavailable,
    Dataloss,
}

A Twirp error code as defined by https://twitchtv.github.io/twirp/docs/spec_v7.html.

Variants (Non-exhaustive)

Non-exhaustive enums could have additional variants added in future. Therefore, when matching against variants of non-exhaustive enums, an extra wildcard arm must be added to account for any future variants.

Canceled

The operation was cancelled.

Unknown

An unknown error occurred. For example, this can be used when handling errors raised by APIs that do not return any error information.

InvalidArgument

The client specified an invalid argument. This indicates arguments that are invalid regardless of the state of the system (i.e. a malformed file name, required argument, number out of range, etc.).

Malformed

The client sent a message which could not be decoded. This may mean that the message was encoded improperly or that the client and server have incompatible message definitions.

DeadlineExceeded

Operation expired before completion. For operations that change the state of the system, this error may be returned even if the operation has completed successfully (timeout).

NotFound

Some requested entity was not found.

BadRoute

The requested URL path wasn’t routable to a Twirp service and method. This is returned by generated server code and should not be returned by application code (use “not_found” or “unimplemented” instead).

AlreadyExists

An attempt to create an entity failed because one already exists.

PermissionDenied

Unauthenticated

ResourceExhausted

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

FailedPrecondition

The operation was rejected because the system is not in a state required for the operation’s execution. For example, doing an rmdir operation on a directory that is non-empty, or on a non-directory object, or when having conflicting read-modify-write on the same resource.

Aborted

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

OutOfRange

The operation was attempted past the valid range. For example, seeking or reading past end of a paginated collection. Unlike “invalid_argument”, this error indicates a problem that may be fixed if the system state changes (i.e. adding more items to the collection). There is a fair bit of overlap between “failed_precondition” and “out_of_range”. We recommend using “out_of_range” (the more specific error) when it applies so that callers who are iterating through a space can easily look for an “out_of_range” error to detect when they are done.

Unimplemented

The operation is not implemented or not supported/enabled in this service.

Internal

When some invariants expected by the underlying system have been broken. In other words, something bad happened in the library or backend service. Twirp specific issues like wire and serialization problems are also reported as “internal” errors.

Unavailable

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

Dataloss

The operation resulted in unrecoverable data loss or corruption.

Implementations

impl TwirpErrorCode

pub fn http_status_code(&self) -> StatusCode

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

Trait Implementations

impl Clone for TwirpErrorCode

fn clone(&self) -> TwirpErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for TwirpErrorCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for TwirpErrorCode

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for TwirpErrorCode

fn eq(&self, other: &TwirpErrorCode) -> 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 Serialize for TwirpErrorCode

fn serialize<S>(&self, serializer: S) -> Result<S::Ok, S::Error>

where S: Serializer,

Serialize this value into the given Serde serializer.

impl Copy for TwirpErrorCode

impl Eq for TwirpErrorCode

impl StructuralPartialEq for TwirpErrorCode