errjson 0.0.2

Easy complex and intuitive Rust Error json
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
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66

# README

[ErrJson](https://crates.io/crates/errjson): easy complex and intuitive Rust [Error](https://doc.rust-lang.org/std/error/trait.Error.html) json

## Usage

```rust
use errjson::*;
fn myfnc() -> Result<i32, Box<dyn std::error::Error>> {
    ErrJson!(code = "ERR001", message = "An error message")
}
```

return a valid Rust [Error](https://doc.rust-lang.org/std/error/trait.Error.html) with a json stringify

```json
{
    "iserr":true,
    "err":{
        "code":"ERR001",
        "message":"An error message"
    }
}
```

You can also embed cascading errors and get a json that looks like this ([full example code](./examples/full.rs))

```json
{
    "meta": { "whoami": { "filename": "errjson/examples/full.rs", "function": "main", "line": 42 } },
    "iserr": true,
    "err": {
        "code": "ERR0001",
        "message": "Error when main() call myfnc()",
        "origin": {
            "meta": { "whoami": { "filename": "errjson/examples/full.rs", "function": "myfnc", "line": 26 } },
            "iserr": true,
            "err": {
                "code": "ERR0002",
                "message": "Error when myfnc() call mysubfnc()",
                "origin": {
                    "meta": { "whoami": { "filename": "errjson/examples/full.rs", "function": "mysubfnc", "line": 11 } },
                    "iserr": true,
                    "err": {
                        "code": "ERR003",
                        "message": "Error when mysubfnc() call mysubsubfnc()",
                        "origin": "No such file or directory (os error 2)"
                    },
                }
            },
        }
    },
}
```

## Examples

- `cargo run --example full`
- `cargo run --example minimal`

##  Why ErrJson ?

Without [ErrJson](https://crates.io/crates/errjson), you can can write basic `Err` like this, but hard with a complex json, not normalize and difficult to embed 'caused' error.

- `Err(r#"{"error":"json", ...}"#);`
- `Err(serde_json::to_string(serde_json::json!({"error": "json", ...})));`