Skip to content

docs(examples): document hyper-util dependency and TokioIo usage #4197

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
VivaMomentum wants to merge 1 commit into
base: master
Choose a base branch
from
+19 −0
Open

docs(examples): document hyper-util dependency and TokioIo usage #4197

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions examples/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ A complete list of dependencies used across these examples:
```toml
[dependencies]
hyper = { version = "1", features = ["full"] }
hyper-util = { version = "0.1", features = ["full"] }
tokio = { version = "1", features = ["full"] }
pretty_env_logger = "0.5"
http-body-util = "0.1"
Expand All @@ -24,6 +25,24 @@ http = "1"
futures-util = { version = "0.3", default-features = false }
```

### Using Examples in Your Own Project

When copying code from these examples into your own standalone project, note that
the examples in this repository import an internal support module (`#[path = "../benches/support/mod.rs"]`)
to avoid a cyclical workspace dependency on `hyper-util`.

In your own application, add `hyper-util` to your `Cargo.toml`:

```toml
hyper-util = { version = "0.1", features = ["tokio"] }
```

And import `TokioIo` and `TokioTimer` directly from `hyper_util::rt`:

```rust
use hyper_util::rt::{TokioIo, TokioTimer};
```

## Getting Started

### Clients
Expand Down