Enum ApiErrorCode 

pub enum ApiErrorCode {
    Unauthorized,
    Forbidden,
    BadRequest,
    NotFound,
    Conflict,
    InvalidState,
    TooManyRequests,
    Protocol,
    Internal,
}

Stable error code returned to API callers. The set is intentionally small so that integrators can branch on a finite alphabet rather than parsing human-readable messages.

Variants

Unauthorized

The caller is not authenticated, or credentials are invalid.

Forbidden

The caller is authenticated but lacks permission for this operation.

BadRequest

The request payload failed validation.

NotFound

The requested resource does not exist.

Conflict

The request conflicts with current state (e.g. duplicate resource).

InvalidState

The system is in setup mode and the requested endpoint is not allowed until initialization is complete (or the endpoint requires setup mode).

TooManyRequests

Caller is being rate-limited.

Protocol

An OAuth 2.0 / OIDC protocol error. The exact error field follows the relevant RFCs (e.g. invalid_grant, invalid_client).

Internal

Catch-all for anything we did not anticipate. The body deliberately does not carry internal cause; correlate via request_id.

Implementations

impl ApiErrorCode

pub const fn http_status(self) -> u16

HTTP status code commonly associated with this error.

Trait Implementations

impl Clone for ApiErrorCode

fn clone(&self) -> ApiErrorCode

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Copy for ApiErrorCode

impl Debug for ApiErrorCode

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ApiErrorCode

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ApiErrorCode

impl PartialEq for ApiErrorCode

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

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for ApiErrorCode