Struct FlatbedRouteError 

pub struct FlatbedRouteError<D = ()> {
    pub status: StatusCode,
    pub code: String,
    pub message: String,
    pub headers: HeaderMap,
    pub details: Option<D>,
}

HTTP-conformant error type with status code, error code, and optional details

The generic parameter D is the type for structured error details (must be a flatbed-generated struct implementing ToFlatBuffer). Defaults to () for errors without structured details.

Example

// Simple error without details
return Err(FlatbedRouteError::bad_request("Invalid input"));

// Error with code
return Err(FlatbedRouteError::bad_request("Validation failed")
    .code("VALIDATION_ERROR"));

// Error with typed details (flatbed-generated struct)
return Err(FlatbedRouteError::bad_request("Validation failed")
    .code("VALIDATION_ERROR")
    .with_details(ValidationErrorDetails {
        field: Some("email".into()),
        reason: Some("Invalid format".into()),
    }));

Fields

status: StatusCode

HTTP status code

code: String

Application-defined error code (e.g., “VALIDATION_ERROR”)

message: String

Human-readable error message

headers: HeaderMap

Response headers

details: Option<D>

Optional structured error details

Implementations

impl FlatbedRouteError<()>

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

Create a 400 Bad Request error

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

Create a 401 Unauthorized error

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

Create a 403 Forbidden error

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

Create a 404 Not Found error

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

Create a 409 Conflict error

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

Create a 422 Unprocessable Entity error

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

Create a 500 Internal Server Error

pub fn with_status(status: StatusCode, message: impl Into<String>) -> Self

Create an error with custom status code

impl<D> FlatbedRouteError<D>

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

Set the error code (builder pattern)

pub fn header(self, key: impl AsRef<str>, value: impl AsRef<str>) -> Self

Add a header to the error response (builder pattern)

pub fn with_details<D2>(self, details: D2) -> FlatbedRouteError<D2>

Add structured details to the error, changing the type parameter

pub fn status_code(&self) -> StatusCode

Get the HTTP status code

Trait Implementations

impl<D: Clone> Clone for FlatbedRouteError<D>

fn clone(&self) -> Self

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<D: Debug> Debug for FlatbedRouteError<D>

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

Formats the value using the given formatter.

impl<D> Display for FlatbedRouteError<D>

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

Formats the value using the given formatter.

impl<D: Debug> Error for FlatbedRouteError<D>

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.