Skip to main content

ErrorCategory

Enum ErrorCategory 

Source
#[non_exhaustive]
pub enum ErrorCategory { BadRequest, Unauthorized, Forbidden, NotFound, UnprocessableEntity, Conflict, RateLimited, Timeout, Unavailable, Internal, }
Expand description

A coarse classification every klauthed error maps onto.

The category is the single source of truth for cross-cutting policy — HTTP status, retryability, client-vs-server — so individual error types only have to answer “which category am I?” rather than re-deriving an HTTP code each.

Variants (Non-exhaustive)§

This enum is marked as 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.
§

BadRequest

Caller sent something invalid (validation, malformed input). 400.

§

Unauthorized

Authentication is missing or invalid. 401.

§

Forbidden

Authenticated but not allowed. 403.

§

NotFound

The target resource does not exist. 404.

§

UnprocessableEntity

The request was structurally valid but semantically unprocessable — e.g. a field value fails a business rule, a required relationship does not exist, or a constraint would be violated. 422.

Distinct from BadRequest: the server understood the request; it simply cannot be fulfilled as-is. Use this for validation errors surfaced after successful parsing.

§

Conflict

The request conflicts with current state. 409.

§

RateLimited

The caller has been rate limited. 429.

§

Timeout

The operation timed out. 504.

§

Unavailable

A dependency (DB, cache, broker, upstream) is unavailable. 503.

§

Internal

An unexpected server-side fault. 500.

Implementations§

Source§

impl ErrorCategory

Source

pub fn http_status(&self) -> u16

The conventional HTTP status for this category.

Source

pub fn is_retryable(&self) -> bool

Whether retrying the operation might succeed (transient conditions).

Source

pub fn is_client_error(&self) -> bool

Whether this represents a caller error (4xx) rather than a server fault.

Source

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

A stable, lowercase label.

Trait Implementations§

Source§

impl Clone for ErrorCategory

Source§

fn clone(&self) -> ErrorCategory

Returns a duplicate of the value. Read more
1.0.0 (const: unstable) · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Copy for ErrorCategory

Source§

impl Debug for ErrorCategory

Source§

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

Formats the value using the given formatter. Read more
Source§

impl<'de> Deserialize<'de> for ErrorCategory

Source§

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>
where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer. Read more
Source§

impl Display for ErrorCategory

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Eq for ErrorCategory

Source§

impl Hash for ErrorCategory

Source§

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

Feeds this value into the given Hasher. Read more
1.3.0 · Source§

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

Feeds a slice of this type into the given Hasher. Read more
Source§

impl PartialEq for ErrorCategory

Source§

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

Tests for self and other values to be equal, and is used by ==.
1.0.0 (const: unstable) · Source§

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

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.
Source§

impl Serialize for ErrorCategory

Source§

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

Serialize this value into the given Serde serializer. Read more
Source§

impl StructuralPartialEq for ErrorCategory

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> DeserializeOwned for T
where T: for<'de> Deserialize<'de>,

Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T> ToString for T
where T: Display + ?Sized,

Source§

fn to_string(&self) -> String

Converts the given value to a String. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.