README.md
1[](https://crates.io/crates/hyper-timeout)
2
3# hyper-timeout
4
5A connect, read and write timeout aware connector to be used with hyper `Client`.
6
7## Problem
8
9At the time this crate was created, hyper does not support timeouts. There is a way to do general timeouts, but no easy way to get connect, read and write specific timeouts.
10
11## Solution
12
13There is a `TimeoutConnector` that implements the `hyper::Connect` trait. This connector wraps around `HttpConnector` or `HttpsConnector` values and provides timeouts.
14
15**Note:** In hyper 0.11, a read or write timeout will return a _broken pipe_ error because of the way `tokio_proto::ClientProto` works
16
17## Usage
18
19Hyper version compatibility:
20
21* The `master` branch will track on going development for hyper.
22* The `0.4` release supports hyper 0.14.
23* The `0.3` release supports hyper 0.13.
24* The `0.2` release supports hyper 0.12.
25* The `0.1` release supports hyper 0.11.
26
27Assuming you are using hyper 0.14, add this to your `Cargo.toml`:
28
29```toml
30[dependencies]
31hyper-timeout = "0.4"
32```
33
34See the [client example](./examples/client.rs) for a working example.
35
36## License
37
38Licensed under either of
39 * Apache License, Version 2.0 ([LICENSE-APACHE](LICENSE-APACHE) or http://www.apache.org/licenses/LICENSE-2.0)
40 * MIT license ([LICENSE-MIT](LICENSE-MIT) or http://opensource.org/licenses/MIT)
41at your option.
42
43### Contribution
44
45Unless you explicitly state otherwise, any contribution intentionally submitted
46for inclusion in the work by you, as defined in the Apache-2.0 license, shall be dual licensed as above, without any
47additional terms or conditions.
48
){kind=link}