Struct JsonApiError 

pub struct JsonApiError { /* private fields */ }

A JSON:API error response, usable both as an axum extractor Rejection and as an IntoResponse error returned from a handler.

Implementations

impl JsonApiError

pub fn from_core(error: &Error) -> Self

Build from a jsonapi_core::Error, mapping it to the correct status and a JSON:API error document.

pub fn from_api_errors(errors: impl IntoIterator<Item = ApiError>) -> Self

Build from one or more ApiErrors.

pub fn from_api_error(error: ApiError) -> Self

Build from a single ApiError.

pub fn from_status(status: StatusCode, detail: Option<String>) -> Self

Build a JSON:API error response for a bare HTTP status (with optional human-readable detail).

Used to re-shape errors that originate as a plain status rather than a jsonapi_core::Error — e.g. an axum body-size-limit rejection (413) or an unmatched-route fallback (404).

pub fn conflict(detail: impl Into<String>) -> Self

Build a 409 Conflict JSON:API error for an id collision (a chosen id that already exists), with source.pointer /data/id. Collision detection is the application’s job; this produces the error to return.

pub fn not_found(detail: impl Into<String>) -> Self

Build a 404 Not Found JSON:API error with a human-readable detail.

pub fn forbidden(detail: impl Into<String>) -> Self

Build a 403 Forbidden JSON:API error with a human-readable detail.

pub fn unprocessable(detail: impl Into<String>) -> Self

Build a 422 Unprocessable Entity JSON:API error with a human-readable detail — for a well-formed request that fails semantic validation.

pub fn unprocessable_with_pointer( pointer: impl Into<String>, detail: impl Into<String>, ) -> Self

Build a 422 Unprocessable Entity error carrying both a detail and a source.pointer (an RFC 6901 JSON pointer to the offending member, e.g. /data/relationships/author) — the common shape for a failed attribute/relationship validation.

pub fn internal(detail: impl Into<String>) -> Self

Build a 500 Internal Server Error JSON:API error.

The detail you pass is treated as internal, potentially sensitive text: it is not placed in the response body unless the debug-errors feature is enabled, so raw error strings never leak to clients by default. Log the raw message in your application if you need it. The response always carries the generic “Internal Server Error” title and no detail.

Trait Implementations

impl Clone for JsonApiError

fn clone(&self) -> JsonApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for JsonApiError

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

Formats the value using the given formatter.

impl From<ApiErrors> for JsonApiError

fn from(errors: ApiErrors) -> Self

Converts to this type from the input type.

impl From<Box<ApiError>> for JsonApiError

fn from(error: Box<ApiError>) -> Self

Converts to this type from the input type.

impl From<Error> for JsonApiError

fn from(error: Error) -> Self

Converts to this type from the input type.

impl IntoResponse for JsonApiError

fn into_response(self) -> Response

Create a response.