Struct ApiErrorBody 

pub struct ApiErrorBody<E = Value> {
    pub message: String,
    pub status: u16,
    pub code: String,
    pub error: E,
}

Envelope for HTTP error responses produced by #[derive(ApiError)].

The type parameter E determines the shape of the error field. When generated by the macro, E is the concrete error enum — giving frontends a fully typed payload. The default (serde_json::Value) is used by layer contributions and hand-rolled error responses where the concrete type is not known.

Example

use doxa::ApiErrorBody;

let body: ApiErrorBody<()> =
    ApiErrorBody::new(404, "not_found", "widget 7 does not exist", ());
let json = serde_json::to_value(&body).unwrap();
assert_eq!(json["status"], 404);
assert_eq!(json["code"], "not_found");
assert_eq!(json["message"], "widget 7 does not exist");

Fields

message: String

Human-readable message from the source error’s Display impl.

status: u16

HTTP status code, mirrored from the response status line.

code: String

Application-level error code suitable for client-side discrimination (e.g. "not_found", "validation_error").

error: E

Typed, machine-readable error data. When E is a concrete error enum, this field carries the enum’s serde serialization. When E is the default serde_json::Value, it accepts any JSON value.

Implementations

impl<E: Serialize> ApiErrorBody<E>

pub fn new( status: u16, code: impl Into<String>, message: impl Into<String>, error: E, ) -> Self

Construct an ApiErrorBody from its raw fields.

Most callers should let #[derive(ApiError)] build this for them; this constructor exists for hand-rolled error responses, layer contributions, and tests.

Trait Implementations

impl<E: Clone> Clone for ApiErrorBody<E>

fn clone(&self) -> ApiErrorBody<E>

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl<E> ComposeSchema for ApiErrorBody<E>

where E: ToSchema,

fn compose(generics: Vec<RefOr<Schema>>) -> RefOr<Schema>

impl<E: Debug> Debug for ApiErrorBody<E>

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

Formats the value using the given formatter.

impl<'de, E> Deserialize<'de> for ApiErrorBody<E>

where E: DeserializeOwned,

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl<E> Serialize for ApiErrorBody<E>

where E: Serialize,

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl<E> ToSchema for ApiErrorBody<E>

where E: ToSchema,

fn name() -> Cow<'static, str>

Return name of the schema.

fn schemas(schemas: &mut Vec<(String, RefOr<Schema>)>)

Implement reference utoipa::openapi::schema::Schemas for this type.