awred 0.1.0

A convenient derive macro for actix_web::ResponseError trait
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38

# awred
A convenient derive macro for `actix_web::ResponseError` trait.

## Example
```rust
use awred::ResponseError;
use serde::Serialize;
use thiserror::Error;

#[derive(Debug, Error, ResponseError, Serialize)]
pub enum AnError {
    #[error("Requested resource was not found")]
    #[response(NOT_FOUND)]
    ResourceNotFound,

    #[error("Forbidden: {reason}")]
    #[response(FORBIDDEN)]
    Forbidden { reason: String },

    // Internal Server Error
    #[error(transparent)]
    #[serde(skip)]
    IoError(#[from] std::io::Error),
}
```

## Details
- Status codes (from `actix_web::http::StatusCode`) are specified in `#[response(...)]` attribute
- Variants without `#[response(...)]` attribute return Internal Server Error with empty body
- Response body consists of serialised error and message (`error.to_string()`)

## Error response body format
```json
{
    "error": "error",
    "message": "error.to_string()",
}
```