rocket_error_stack 0.1.0

Compatibility Wrapper for error-stack and rocket
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

# rocket_error_stack

## Description
This crate provides [rocket_error_stack::Report]
and [rocket_error_stack::Result] as thin Wrappers around
[error_stack::Report] and [error_stack::Result] with
rockets [rocket::response::Responder] implemented.

## Install

```toml
[dependencies]
rocket = { version = "0.5.0-rc.2" }
error-stack = "0.2"
rocket_error_stack = "0.1"
```

## Note about required trait implementations

Your Reports will have to implement
[rocket_error_stack::StatusCodeReport] to
define the HTTP response code.

## Supported versions

This crate currently supports rocket
0.5.0-rc.2 and error-stack 0.2.

## Usage

```rust
use std::fmt;
use rocket::http::Status;
use error_stack::{Context, IntoReport, ResultExt};
use std::fs;

use rocket_error_stack::{Result, StatusCodeReport};

#[derive(Debug)]
struct SomeError(pub Status);

impl StatusCodeReport for SomeError {
  fn status(&self) -> Status {
      self.0
  }
}

impl fmt::Display for SomeError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        f.write_str("Error during request")
    }
}

impl Context for SomeError {}

#[get("/")]
fn get() -> Result<(), SomeError> {
  fs::read_to_string("nonexistent")
    .into_report()
    .attach_printable("Something went wrong!")
    .change_context(SomeError(Status::InternalServerError))?;
  Ok(())
}

```