#error #axum #macro #macro-derive

macro axum_error_macro

Simple derive macro for your custom Error enum to generate quickly its status code and message

4 releases

0.1.7 Oct 22, 2023
0.1.6 Oct 22, 2023
0.1.4 Aug 21, 2023

#1022 in Procedural macros

MIT license

13KB
180 lines

Installation:

[dependencies]
axum_error_macro = { version = "0.1.7" }

Simple example

use axum_error_macro::ErrorResponse;
use axum::response::Response;

#[derive(ErrorResponse)]
#[error_format("application/json")]
enum Error {
  #[error(code = 500, msg = "Internal Server Error!!!")]
  InternalServerError,

  #[error(code = 400, msg = "Bad Request!!!")]
  BadRequest,

  #[error(code = 404, msg = "User by {} id was not found")]
  UserByIdNotFound(u32),

  #[error(code = 404, msg = "User by {} username with {} role was not found")]
  UserByUsernameAndRoleNotFound(String, String),

  #[error(code = 404, msg = "User {:?} was not found")]
  UserNotFound(User)
}

#[derive(Debug)]
struct User {
  username: String
}

fn server_error_handler() -> Response {
  return Error::InternalServerError.into_response();
}

fn user_by_id_handler() -> Response {
  return Error::UserByIdNotFound(1).into_response();
}

fn user_by_username_and_role_handler() -> Response {
  return Error::UserByUsernameAndRoleNotFound("Bebra".into(), "ADMIN".into()).into_response();
}

fn user_handler() -> Response {
  let user = User {
    username: "Bebra".into()
  };
  return Error::UserNotFound(user).into_response();
}

Also you can configure error response format with #[error_format(...)] macro. Today only "application/json" and "text/plain" are available.

Returned data will be in this format:

{
  "message": "Internal Server Error!!!"
}

or

Internal Server Error!!!

Dependencies

~6–13MB
~155K SLoC