hightide 0.1.0

extension for the tide web framework
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

Hightide
--------

Hightide is an extension to the tide web framework.
It provides a higher level interface for building responses.

To use it wrap your endpoint with the `wrap` function. This wrapper allows your endpoints to
return various types that implement the `Responder` trait.

Hightide also includes a Response type that is easier to use than the one provided by
tide. It has shortcut methods for setting the body to a JSON or Form payload, and for adding
typed headers from the `hyperx` crate.

`Responder` is implemented for various types, for example `(StatusCode, impl Responder)` which
allows you to do:

```
use tide::{Request, StatusCode};
use hightide::Responder;

fn example(_: tide::Request<()>) -> impl Responder {
     (StatusCode::Conflict, "Already Exists")
}
```

Which is simpler than the equivalent code from plain `tide`:

```
use tide::{Request, StatusCode};
use hightide::Responder;

fn example(_: Request<()>) -> tide::Result {
    Ok(Response::builder(StatusCode::Conflict)
        .body("Already Exists")
        .build())
}
```

The `Json` wrapper also allows returning a JSON response more directly.

```
use tide::{Request};
use hightide::{Responder, Json};

fn example(_: tide::Request<()>) -> impl Responder {
     Json(MyData{ ... })
}
```

Compared to:

```
use tide::{Request, StatusCode};

fn example(_: Request<()>) -> tide::Result {
    Ok(Response::builder(StatusCode::Ok)
        .body(Body::from_json(&MyData{ ... })?)
        .build())
}
```