Struct HttpError 

pub struct HttpError {
    pub status: StatusCode,
    pub detail: Option<String>,
    pub headers: Vec<(String, Vec<u8>)>,
    pub debug_info: Option<DebugInfo>,
}

HTTP error that produces a response.

When debug mode is enabled, errors can include additional diagnostic information via the debug_info field. This information is conditionally serialized into the response when is_debug_mode_enabled() returns true.

Production Mode (default)

{"detail": "Not Found"}

Debug Mode (when enabled)

{
  "detail": "Not Found",
  "debug": {
    "source_file": "src/handlers/user.rs",
    "source_line": 42,
    "function_name": "get_user",
    "route_pattern": "/users/{id}"
  }
}

Fields

status: StatusCode

Status code.

detail: Option<String>

Error detail message.

headers: Vec<(String, Vec<u8>)>

Additional headers.

debug_info: Option<DebugInfo>

Debug information (only included in response when debug mode is enabled).

Implementations

impl HttpError

pub fn new(status: StatusCode) -> Self

Create a new HTTP error.

pub fn with_detail(self, detail: impl Into<String>) -> Self

Add a detail message.

pub fn with_header( self, name: impl Into<String>, value: impl Into<Vec<u8>>, ) -> Self

Add a header.

pub fn with_debug_info(self, debug_info: DebugInfo) -> Self

Add debug information.

This information will only be included in the response when debug mode is enabled (via enable_debug_mode()).

Example

use fastapi_core::error::{HttpError, DebugInfo};

let error = HttpError::not_found()
    .with_detail("User not found")
    .with_debug_info(DebugInfo::new()
        .with_source_location("src/handlers/user.rs", 42, "get_user")
        .with_route_pattern("/users/{id}"));

pub fn with_debug_location(self, function_name: impl Into<String>) -> Self

Add debug information at the current source location.

This is a convenience method that captures the current file and line. Note: This captures the location where this method is called, not where the error originated. For accurate source tracking, use with_debug_info with a DebugInfo created via the debug_location! macro.

pub fn bad_request() -> Self

Create a 400 Bad Request error.

pub fn unauthorized() -> Self

Create a 401 Unauthorized error.

pub fn forbidden() -> Self

Create a 403 Forbidden error.

pub fn not_found() -> Self

Create a 404 Not Found error.

pub fn internal() -> Self

Create a 500 Internal Server Error.

pub fn payload_too_large() -> Self

Create a 413 Payload Too Large error.

pub fn unsupported_media_type() -> Self

Create a 415 Unsupported Media Type error.

Trait Implementations

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, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

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

Convert into a response.