Struct ApiError 

pub struct ApiError { /* private fields */ }

An HTTP error rendered as an RFC 7807 application/problem+json document.

Implementations

impl ApiError

pub fn new(status: StatusCode, detail: impl Into<String>) -> Self

Create an error with an arbitrary status and human-readable detail.

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

404 Not Found.

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

400 Bad Request.

pub fn unprocessable(errors: Value) -> Self

422 Unprocessable Entity carrying structured validation errors.

pub fn internal(source: impl Display) -> Self

500 Internal Server Error. source is logged but never sent to the client.

pub fn with_type(self, type_uri: impl Into<String>) -> Self

Override the problem type URI (defaults to about:blank).

pub fn with_code(self, code: &'static str) -> Self

Set the stable machine-readable code extension member of the problem document, for clients that branch on the kind of failure.

pub fn with_header(self, name: HeaderName, value: HeaderValue) -> Self

Attach a response header (appended if the name is already set).

pub fn absent(self) -> Self

Mark this error as “the input is not there at all” rather than “the input is there but wrong”.

Option<T> extractors turn absent errors into None and let every other error through, so a malformed value still fails the request.

pub fn is_absent(&self) -> bool

Whether this error was marked with absent.

pub fn headers(&self) -> Option<&HeaderMap>

Extra response headers attached with with_header.

pub fn status(&self) -> StatusCode

The HTTP status code.

pub fn title(&self) -> &str

The short, status-derived title.

pub fn detail(&self) -> Option<&str>

The human-readable detail, if any.

pub fn errors(&self) -> Option<&Value>

Structured error extension, if any.

pub fn code(&self) -> Option<&str>

The machine-readable error code, if any.

Trait Implementations

impl Clone for ApiError

fn clone(&self) -> ApiError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ApiError

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

Formats the value using the given formatter.

impl Display for ApiError

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

Formats the value using the given formatter.

impl Error for ApiError

fn source(&self) -> Option<&(dyn Error + 'static)>

Returns the lower-level source of this error, if any.

fn description(&self) -> &str

👎Deprecated since 1.42.0:

use the Display impl or to_string()

fn cause(&self) -> Option<&dyn Error>

👎Deprecated since 1.33.0:

replaced by Error::source, which can support downcasting

fn provide<'a>(&'a self, request: &mut Request<'a>)

🔬This is a nightly-only experimental API. (error_generic_member_access)

Provides type-based access to context intended for error reports.

impl From<BodyError> for ApiError

fn from(err: BodyError) -> Self

Converts to this type from the input type.

impl From<OrmError> for ApiError

fn from(err: OrmError) -> Self

Converts to this type from the input type.

impl IntoResponse for ApiError

fn into_response(self) -> Response

Build the response.

fn describe(op: &mut Operation, registry: &mut SchemaRegistry)

Document the responses this type can produce.