#axum #error-response #enums #derive #status-code #message

macro axum-enum-response

Use enums as Axum Response's easily

3 releases

0.1.2 Feb 28, 2024
0.1.1 Feb 28, 2024
0.1.0 Feb 28, 2024

#1623 in Web programming

30 downloads per month

MIT/Apache

9KB
149 lines

axum-enum-error

MSRV: 1.65.0

Easily use an enum as an Axum Response type.

Example Usage

#[derive(serde::Serialize)]
struct SomeData {
	meow: String,
}

#[derive(EnumIntoResponse)]
enum ErrorResponse {
	#[status_code(UNAUTHORIZED)]
	Unauthorized, // 401, empty body
	#[status_code(FORBIDDEN)]
	#[message("mew")]
	Forbidden, // 403, body = {"message": "mew"}
	#[status_code(BAD_REQUEST)]
	BadRequest(SomeData),
	#[status_code(INTERNAL_SERVER_ERROR)]
	InternalServerError(#[key("error")] String), // 500, body = {"error": STRING},
}

lib.rs:

Simple way to use an enum as an Axum Response MSRV: 1.65.0

Example Usage

#[derive(axum_enum_response::EnumIntoResponse)]
enum ErrorResponse {
   #[status_code(UNAUTHORIZED)]
   Unauthorized, // 401, empty body
   #[status_code(FORBIDDEN)]
   #[message("mew")]
   Forbidden, // 403, body = {"message": "mew"}
   #[status_code(INTERNAL_SERVER_ERROR)]
   InternalServerError(#[key("error")] String), // 500, body = {"error": STRING}
}

You can also use any struct that implements serde::Serialize as a field like this:

#[derive(serde::Serialize)]
struct SomeData {
    meow: String,
}

#[derive(axum_enum_response::EnumIntoResponse)]
enum ErrorResponse {
    #[status_code(BAD_REQUEST)]
    BadRequest(SomeData), // 400, body = {"meow": STRING}
}

Dependencies

~345–800KB
~19K SLoC