http-serde-ext 0.1.7

serde support for http crate types Request, Response, Uri, StatusCode, HeaderMap, Method, in Option or other collections
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
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104

## [`serde`](https://github.com/serde-rs/serde) extensions for the [`http`](https://github.com/hyperium/http) crate types

Allows serializing and deserializing the following types from [`http`](https://github.com/hyperium/http):

- [`Response`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/response)
- [`Request`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/request)
- [`HeaderMap`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/header_map)
- [`StatusCode`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/status_code)
- [`Uri`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/uri)
- [`Method`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/method)
- [`HeaderName`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/header_name)
- [`HeaderValue`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/header_value)
- [`uri::Authority`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/authority)
- [`uri::Scheme`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/scheme)
- [`uri::PathAndQuery`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/path_and_query)
- [`Version`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/version)
- Generic [`HeaderMap<T>`](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext/header_map_generic) where the item is not a `HeaderValue`

Allows serializing and deserializing the above types wrapped in the following `std` container types:

- [`Option`](https://doc.rust-lang.org/std/option/enum.Option.html)
- [`Result`] in the `Ok` position
- [`Vec`](https://doc.rust-lang.org/std/vec/struct.Vec.html)
- [`VecDeque`](https://doc.rust-lang.org/std/collections/struct.VecDeque.html)
- [`LinkedList`](https://doc.rust-lang.org/std/collections/struct.LinkedList.html)
- [`HashMap`](std::collections::HashMap) as the `Key` for all except `HeaderMap`, `Request`, and `Response`. As the `Value` for all types.
- [`BTreeMap`](std::collections::BTreeMap) as the `Key` only for `HeaderValue`, `StatusCode`, and `Version`. As the `Value` for all types.
- [`HashSet`](std::collections::HashSet) for all except `HeaderMap`, `Request`, and `Response`
- [`BTreeSet`](std::collections::BTreeSet) only for `HeaderValue`, `StatusCode`, and `Version`

### Installation

Run the following Cargo command in your project directory:

```bash
cargo add http-serde-ext
```

Or add the following line to your Cargo.toml:

```toml
http-serde-ext = "0.1.7"
```

### Usage

This library is intended to be used with `serde`'s `derive` feature.
Fields should use the appropriate `#[serde(with = "...")]` annotation for that
type. Full examples are provided in each module section of the [docs](https://docs.rs/http-serde-ext/0.1.7/http_serde_ext).

```rust
use std::collections::*;

use http::*;
use serde::{Serialize, Deserialize};

#[derive(Serialize, Deserialize)]
struct MyStruct {
    #[serde(with = "http_serde_ext::response")]
    base: Response<Vec<u8>>,

    #[serde(with = "http_serde_ext::request::option")]
    option: Option<Request<String>>,

    #[serde(with = "http_serde_ext::method::vec")]
    vec: Vec<Method>,

    #[serde(with = "http_serde_ext::uri::vec_deque")]
    vec_deque: VecDeque<Uri>,

    #[serde(with = "http_serde_ext::header_map::linked_list")]
    linked_list: LinkedList<HeaderMap>,

    #[serde(with = "http_serde_ext::header_map_generic::hash_map")]
    hash_map: HashMap<String, HeaderMap<String>>,

    #[serde(with = "http_serde_ext::status_code::btree_map_key")]
    btree_map: BTreeMap<StatusCode, i32>,

    #[serde(with = "http_serde_ext::authority::hash_set")]
    hash_set: HashSet<uri::Authority>,
}
```

This library can also be used to manually `De`/`Serialize` types if given a
`De`/`Serializer`. For example, when using `serde_json`:

```rust
let uri = http::Uri::default();
let serialized = http_serde_ext::uri::serialize(&uri, serde_json::value::Serializer).unwrap();
let deserialized = http_serde_ext::uri::deserialize(serialized).unwrap();
assert_eq!(uri, deserialized);

let responses: Vec<http::Response<()>> = vec![http::Response::default()];
let serialized =
    http_serde_ext::response::vec::serialize(&responses, serde_json::value::Serializer)
        .unwrap();
let deserialized: Vec<http::Response<()>> =
    http_serde_ext::response::vec::deserialize(serialized).unwrap();
```

### Acknowledgements

This crate is heavily inspired by [Kornel's](https://github.com/kornelski) [`http-serde`](https://crates.io/crates/http-serde).