Skip to main content

ErrorCode

Enum ErrorCode 

Source
pub enum ErrorCode {
Show 13 variants NotFound, Forbidden, PolicyUnavailable, MissingTenant, InvalidAttribute, InvalidParameter, Conflict, PreconditionFailed, LockContention, Closing, Unsupported, UnsupportedMediaType, Internal,
}
Expand description

The JSON:API code values this crate emits, and the HTTP status each carries.

Variants§

§

NotFound

UnknownResource / UnknownAction / NotFound.

§

Forbidden

A deliberate policy denial.

§

PolicyUnavailable

A policy outage — distinct from a denial, and retriable.

§

MissingTenant

§

InvalidAttribute

A validation failure on a specific attribute.

§

InvalidParameter

A malformed or unknown query parameter — an unknown sort attribute, filter key or include path, or two pagination strategies at once. Resolved against the schema before the data layer is touched.

§

Conflict

Optimistic-concurrency failure; retriable.

§

PreconditionFailed

The If-Match precondition was supplied and stale.

§

LockContention

§

Closing

The domain is draining. A lifecycle signal, not a fault.

§

Unsupported

§

UnsupportedMediaType

The request body was not sent as application/vnd.api+json.

JSON:API requires the media type on any request carrying a document, and requires 415 when it is missing — a body sent as application/json is refused rather than guessed at.

§

Internal

DataLayer / Serialization. The message is never surfaced.

Implementations§

Source§

impl ErrorCode

Source

pub fn status(self) -> StatusCode

The HTTP status for this code.

Source

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

The wire value of the JSON:API code member.

Source

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

A short, human-readable title. Safe to show a client.

Not StatusCode::canonical_reason(): three of these codes are 503, and “Service Unavailable” would collapse the distinction between a policy outage, lock contention and a draining server that the codes exist to preserve.

Source

pub fn is_retriable(self) -> bool

Whether the client may retry. Drives Retry-After.

Source

pub fn is_sanitized(self) -> bool

Whether the underlying error’s message must be withheld from the response body.

Trait Implementations§

Source§

impl Clone for ErrorCode

Source§

fn clone(&self) -> Self

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 ErrorCode

Source§

impl Debug for ErrorCode

Source§

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

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

impl Eq for ErrorCode

Source§

impl PartialEq for ErrorCode

Source§

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

Equality operator ==. Read more
1.0.0 (const: unstable) · Source§

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

Inequality operator !=. Read more
Source§

impl StructuralPartialEq for ErrorCode

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> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<B> FromRef<B> for B
where B: Clone,

Source§

fn from_ref(backend: &B) -> B

Extract a Self from a reference to the composite backend B.
Source§

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

Source§

fn from_ref(input: &T) -> T

Converts to this type from a reference to the input type.
Source§

impl<A, B, T> HttpServerConnExec<A, B> for T
where B: Body,

Source§

impl<T> Instrument for T

Source§

fn instrument(self, span: Span) -> Instrumented<Self> ⓘ

Instruments this type with the provided Span, returning an Instrumented wrapper. Read more
Source§

fn in_current_span(self) -> Instrumented<Self> ⓘ

Instruments this type with the current Span, returning an Instrumented wrapper. Read more
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, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = !

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

fn try_from(value: U) -> Result<T, !>

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.
Source§

impl<T> WithSubscriber for T

Source§

fn with_subscriber<S>(self, subscriber: S) -> WithDispatch<Self> ⓘ
where S: Into<Dispatch>,

Attaches the provided Subscriber to this type, returning a WithDispatch wrapper. Read more
Source§

fn with_current_subscriber(self) -> WithDispatch<Self> ⓘ

Attaches the current default Subscriber to this type, returning a WithDispatch wrapper. Read more