Struct HttpError 

pub struct HttpError { /* private fields */ }

HTTP error response with stable client-facing JSON shape.

HttpError constructors produce the legacy/simple body { "error": { "code": "...", "message": "..." } }. When ErrorEnvelopeLayer is installed, that body is wrapped into the production envelope with status, timestamp, path, and request ID fields.

Client-error constructors such as Self::bad_request and Self::not_found expose the message you provide. Use Self::internal_server_error for 500 responses that must not leak implementation details; the production envelope also masks any 5xx response message to "internal server error" and clears details.

Implementations

impl HttpError

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

Creates an HTTP error with an explicit status, code, and message.

For non-5xx statuses, the message is client-facing. For 5xx statuses, prefer Self::internal_server_error unless the response is guaranteed to be safe; ErrorEnvelopeLayer will still mask 5xx messages.

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

Creates a 400 bad request error with a client-facing message.

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

Creates a 401 unauthorized error with a client-facing message.

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

Creates a 403 forbidden error with a client-facing message.

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

Creates a 404 not found error with a client-facing message.

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

Creates a 409 conflict error with a client-facing message.

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

Creates a 429 too many requests error with a client-facing message.

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

Creates a 422 unprocessable entity error with a client-facing message.

pub fn internal_server_error() -> Self

Creates a sanitized 500 internal server error.

The message is always "internal server error" so callers do not accidentally expose database errors, stack traces, or upstream payloads.

pub fn status(&self) -> StatusCode

Returns the HTTP status code.

pub fn code(&self) -> &'static str

Returns the stable machine-readable error code.

pub fn message(&self) -> &str

Returns the client-facing error message.

Trait Implementations

impl Clone for HttpError

fn clone(&self) -> HttpError

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HttpError

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

Formats the value using the given formatter.

impl Display for HttpError

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

Formats the value using the given formatter.

impl Eq for HttpError

impl Error for HttpError

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 IntoResponse for HttpError

fn into_response(self) -> Response

Create a response.

impl PartialEq for HttpError

fn eq(&self, other: &HttpError) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl StructuralPartialEq for HttpError