Struct Error 

pub struct Error { /* private fields */ }

A framework error: a kind, a human message, an optional structured details payload, and an optional underlying cause.

Implementations

impl Error

pub fn new(kind: ErrorKind, message: impl Into<String>) -> Error

Build an error of an explicit kind.

pub fn internal(message: impl Into<String>) -> Error

500 — an internal failure.

pub fn bad_request(message: impl Into<String>) -> Error

400 — a malformed request.

pub fn unauthenticated(message: impl Into<String>) -> Error

401 — missing or invalid credentials.

pub fn unauthorized(message: impl Into<String>) -> Error

403 — authenticated but not permitted.

pub fn not_found(message: impl Into<String>) -> Error

404 — nothing matched.

pub fn conflict(message: impl Into<String>) -> Error

409 — conflicting state.

pub fn request_timeout(message: impl Into<String>) -> Error

408 — the request took longer than this service is prepared to wait.

What a Timeout middleware returns. 408 rather than 504: the timeout is this service’s own decision about its own handler, not a report about something upstream.

pub fn too_many_requests(message: impl Into<String>) -> Error

429 — throttled.

The caller should also send a retry-after; nothing here can know what to put in it.

pub fn service_unavailable(message: impl Into<String>) -> Error

503 — a dependency is down, or the application is in maintenance.

The honest answer when a health check cannot reach the database. A 500 says “this service is broken”; a 503 says “try again”, which is what a load balancer and a retrying client both need to hear.

pub fn validation(details: Value) -> Error

422 with a structured field-error payload — what a failed FormRequest produces.

pub fn with_details(self, details: Value) -> Error

Attach a structured payload rendered alongside the message.

pub fn with_source(self, source: impl Into<Error>) -> Error

Attach the underlying cause.

pub fn with_kind(self, kind: ErrorKind) -> Error

Re-label the kind (and therefore the status) without losing the rest.

pub fn kind(&self) -> ErrorKind

This error’s kind.

pub fn status(&self) -> u16

The HTTP status this error renders as.

pub fn message(&self) -> &str

The human-readable message.

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

The structured payload, if any.

pub fn source_error(&self) -> Option<&Error>

The underlying cause, if one was attached.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

Formats the value using the given formatter.

impl Error for Error

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<Error> for Error

fn from(source: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Error

fn from(source: Error) -> Error

Converts to this type from the input type.

impl From<Error> for Response

fn from(error: Error) -> Response

Converts to this type from the input type.

impl From<ValidationErrors> for Error

fn from(errors: ValidationErrors) -> Error

A 422 carrying the failures as structured details, which the HTTP layer renders without knowing anything about validation.

impl IntoResponse for Error

Renders a framework error as JSON.

The default, and what an API client should get. The HTTP kernel wraps it with content negotiation — an HTML error page for a browser — using the RenderedError this attaches.

fn into_response(self) -> Response

Build the response.