10 releases

0.2.7 Jun 16, 2024
0.2.6 Jun 14, 2024
0.2.1 Mar 10, 2024
0.2.0 Jun 13, 2023
0.1.7 Apr 26, 2023

#15 in #error-response

Download history 2/week @ 2024-12-29 3583/week @ 2025-01-05 1733/week @ 2025-01-12 1626/week @ 2025-01-19 1439/week @ 2025-01-26 2091/week @ 2025-02-02 3195/week @ 2025-02-09 4402/week @ 2025-02-16 3042/week @ 2025-02-23 4787/week @ 2025-03-02 1756/week @ 2025-03-09 4439/week @ 2025-03-16 4519/week @ 2025-03-23 7483/week @ 2025-03-30 4300/week @ 2025-04-06 2639/week @ 2025-04-13

19,007 downloads per month
Used in actix-web-thiserror

MIT license

20KB
443 lines

actix-web-thiserror

License Contributors GitHub Repo stars crates.io

A crate that extends the thiserror crate functionality to automatically return a proper actix-web response.

Documentation

Error definition

use actix_web_thiserror::ResponseError;
use thiserror::Error;

#[derive(Debug, Error, ResponseError)]
pub enum Base64ImageError {
  #[response(reason = "INVALID_IMAGE_FORMAT")]
  #[error("invalid image format")]
  InvalidImageFormat,
  #[response(reason = "INVALID_STRING")]
  #[error("invalid string")]
  InvalidString,
}

Error implementation

pub async fn error_test() -> Result<HttpResponse, Error> {
  Err(Base64ImageError::InvalidImageFormat)?
}

Error response

The reason is a string that may be given to the client in some form to explain the error, if appropriate. Here it is as an enum that can be localized.

Note: This response has been formatted by a ResponseTransform. To specify a custom ResponseTransform, implement ResponseTransform and add #[response(transform = custom)] under your derive.

{
    "result": 0,
    "reason": "INVALID_IMAGE_FORMAT"
}

Error logging

The error text automatically prints to the log when the error is returned out through a http response.

Apr 23 02:19:35.211 ERROR Response error: invalid image format
    Base64ImageError(InvalidImageFormat), place: example/src/handler.rs:5 example::handler

Dependencies

~15–26MB
~441K SLoC