Struct Error 

pub struct Error { /* private fields */ }

The framework error type.

Error is a single pointer wide, so Result<T, Error> stays small on the success path. It implements IntoResponse, so handlers can return Result<T> directly.

See the module documentation for the response format and the exposure policy.

Implementations

impl Error

pub fn new( status: StatusCode, code: impl Into<Cow<'static, str>>, message: impl Into<Cow<'static, str>>, ) -> Self

Creates an error with an explicit status, machine-readable code and public message.

pub fn bad_request(message: impl Into<Cow<'static, str>>) -> Self

400 Bad Request with code BAD_REQUEST.

pub fn unauthorized(message: impl Into<Cow<'static, str>>) -> Self

401 Unauthorized with code UNAUTHORIZED.

pub fn forbidden(message: impl Into<Cow<'static, str>>) -> Self

403 Forbidden with code FORBIDDEN.

pub fn not_found(message: impl Into<Cow<'static, str>>) -> Self

404 Not Found with code NOT_FOUND.

pub fn method_not_allowed(message: impl Into<Cow<'static, str>>) -> Self

405 Method Not Allowed with code METHOD_NOT_ALLOWED.

pub fn timeout(message: impl Into<Cow<'static, str>>) -> Self

408 Request Timeout with code REQUEST_TIMEOUT.

pub fn conflict(message: impl Into<Cow<'static, str>>) -> Self

409 Conflict with code CONFLICT.

pub fn payload_too_large(message: impl Into<Cow<'static, str>>) -> Self

413 Payload Too Large with code PAYLOAD_TOO_LARGE.

pub fn unsupported_media_type(message: impl Into<Cow<'static, str>>) -> Self

415 Unsupported Media Type with code UNSUPPORTED_MEDIA_TYPE.

pub fn unprocessable(message: impl Into<Cow<'static, str>>) -> Self

422 Unprocessable Entity with code UNPROCESSABLE_ENTITY.

pub fn too_many_requests(message: impl Into<Cow<'static, str>>) -> Self

429 Too Many Requests with code TOO_MANY_REQUESTS.

pub fn service_unavailable(message: impl Into<Cow<'static, str>>) -> Self

503 Service Unavailable with code SERVICE_UNAVAILABLE.

pub fn validation(details: impl Serialize) -> Self

422 Unprocessable Entity with code VALIDATION_FAILED and the given structured details (typically a map of field names to messages).

pub fn internal(source: impl Into<BoxError>) -> Self

500 Internal Server Error with a generic public message.

The source is logged when the response is produced but is never sent to the client.

pub fn with_code(self, code: impl Into<Cow<'static, str>>) -> Self

Replaces the machine-readable error code.

pub fn with_message(self, message: impl Into<Cow<'static, str>>) -> Self

Replaces the public message.

pub fn with_details(self, details: impl Serialize) -> Self

Attaches structured, client-visible details.

If details fails to serialize, the error is kept and the details are omitted (the failure is logged).

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

Attaches a diagnostic source error. It is logged, never sent to clients.

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

Adds a response header (for example Retry-After or WWW-Authenticate).

pub fn status(&self) -> StatusCode

The HTTP status code.

pub fn code(&self) -> &str

The machine-readable error code.

pub fn message(&self) -> &str

The public, client-visible message.

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

Client-visible structured details, if any.

pub fn headers(&self) -> &[(HeaderName, HeaderValue)]

Extra response headers attached to this error.

pub fn source_ref(&self) -> Option<&(dyn Error + Send + Sync + 'static)>

The diagnostic source, if any.

pub fn to_json_body(&self) -> Vec<u8>

Serializes the client-visible JSON body.

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

fn from(err: ConfigError) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<Error> for Error

fn from(err: Error) -> Self

Converts to this type from the input type.

impl From<ServerError> for Error

fn from(err: ServerError) -> Self

Converts to this type from the input type.

impl From<StatusCode> for Error

fn from(status: StatusCode) -> Self

Creates an error from a bare status code, using the canonical reason phrase as the message and an upper-snake-case code.

impl IntoResponse for Error

fn into_response(self) -> Response

Create a response.