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

#34 in #thiserror

Download history 3409/week @ 2024-10-13 4323/week @ 2024-10-20 3772/week @ 2024-10-27 4087/week @ 2024-11-03 7238/week @ 2024-11-10 3331/week @ 2024-11-17 5133/week @ 2024-11-24 3082/week @ 2024-12-01 4387/week @ 2024-12-08 4441/week @ 2024-12-15 2/week @ 2024-12-29 3583/week @ 2025-01-05 1733/week @ 2025-01-12 1626/week @ 2025-01-19 1433/week @ 2025-01-26

8,376 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

~16–27MB
~461K SLoC