Struct Error 

pub struct Error { /* private fields */ }

A framework error that can be turned into an HTTP error response.

The message is considered safe to return to clients for 4xx errors. For 5xx errors the message is redacted in the response body and only the generic INTERNAL_ERROR_MESSAGE is sent, while the original detail and optional cause are logged server-side.

Implementations

impl Error

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

Creates an error of the given kind with a client-facing message.

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

Creates a 400 Bad Request error.

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

Creates a 401 Unauthorized error.

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

Creates a 403 Forbidden error.

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

Creates a 404 Not Found error.

pub fn method_not_allowed(message: impl Into<String>) -> Self

Creates a 405 Method Not Allowed error.

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

Creates a 409 Conflict error.

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

Creates a 422 Unprocessable Entity error.

pub fn payload_too_large(message: impl Into<String>) -> Self

Creates a 413 Payload Too Large error.

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

Creates a 429 Too Many Requests error.

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

Creates a 500 Internal Server Error.

The message is logged but never returned to the client.

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

Creates a 503 Service Unavailable error.

pub fn gateway_timeout(message: impl Into<String>) -> Self

Creates a 504 Gateway Timeout error.

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

Overrides the machine-readable code (otherwise derived from the kind).

pub fn with_source<E>(self, source: E) -> Self

where E: Error + Send + Sync + 'static,

Attaches an underlying error as the cause, for server-side diagnostics.

The cause is logged for server errors but is never serialized into a response body. Its concrete type is recorded so that a typed exception_handler for E can be located and the cause recovered via take_source.

pub fn with_details(self, details: Vec<ErrorDetail>) -> Self

Attaches field-level details, surfaced in the response body for 4xx.

pub fn from_garde_report(report: Report) -> Self

Builds a validation error from a garde report.

The code is set to VALIDATION_FAILED and each reported field path and message becomes an ErrorDetail, with the issue classified from the message on a best-effort basis (garde does not expose structured codes).

pub fn kind(&self) -> ErrorKind

Returns the error category.

pub fn code(&self) -> &str

Returns the machine-readable code (override, otherwise from the kind).

pub fn details(&self) -> &[ErrorDetail]

Returns the field-level details, if any.

pub fn message(&self) -> &str

Returns the client-facing message.

pub fn take_source<E>(&mut self) -> Option<E>

where E: Error + Send + Sync + 'static,

Removes the attached source and returns it as E, if its concrete type matches.

Returns None (leaving the source in place) when no source is attached or its type differs. This is how a typed exception_handler recovers the original error value it was registered for.

Trait Implementations

impl Debug for Error

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

Formats the value using the given formatter.

impl Display for Error

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

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

fn from(error: WsError) -> Self

Converts to this type from the input type.

impl IntoResponse for Error

fn into_response(self) -> Response

Consumes self and produces the HTTP response to send to the client.