Skip to content
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.

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

Document the runtime feature #1613

Closed
sanmai-NL opened this issue Jul 28, 2018 · 7 comments
Closed

Document the runtime feature #1613

sanmai-NL opened this issue Jul 28, 2018 · 7 comments
Labels
A-docs Area: documentation. E-easy Effort: easy. A task that would be a great starting point for a new contributor.

Comments

@sanmai-NL
Copy link
Contributor

sanmai-NL commented Jul 28, 2018

Only found this: d127201. In general, all features should be documented esp. if they are mentioned in e.g. the changelog (i.e. not internal/temporary/experimental).

Question the docs would address:

  1. What is the value of the Tokio runtime itself?
  2. Pointers on how to use alternative runtimes?
@seanmonstar seanmonstar added E-easy Effort: easy. A task that would be a great starting point for a new contributor. A-docs Area: documentation. labels Jul 30, 2018
@seanmonstar
Copy link
Member

Good point! Where is a good place for this to appear? In the module documentation of hyper::rt?

@sanmai-NL
Copy link
Contributor Author

Imagine someone new to hyper. First thing he or she will do is adding it as dependency. Then they’ll ask themselves what features to enable in Cargo.toml. So, the best place would be the README being the first encounter with docs. This short overview of features can contain a pointer perhaps to some elaboration in the API docs.

@danieleades
Copy link
Contributor

I am using hyper (or reqwest) in a couple of projects now, and i'd like to experiment with other runtimes (such as https://github.com/rustasync/runtime). Hyper and reqwest appear to be implicitly dependent on the tokio runtime. Is there a away around this dependency?

@seanmonstar
Copy link
Member

The feature is enabled by default in hyper, you can disable it and provide your own Connect and Executor.

We could open an issue in reqwest about this is as well.

@danieleades
Copy link
Contributor

Ah thanks, that makes perfect sense

Found this a really interesting read-

https://users.rust-lang.org/t/poll-async-await-lets-talk-about-executors/31753

It's about trying to find a consistent way across the ecosystem to make Executor/Spawn generic. Zero consensus of course.

@lorislibralato
Copy link

We can close this because of 1.0 runtime future remove

@seanmonstar
Copy link
Member

Good point!

@seanmonstar seanmonstar closed this as not planned Won't fix, can't repro, duplicate, stale Aug 16, 2022
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-docs Area: documentation. E-easy Effort: easy. A task that would be a great starting point for a new contributor.
Projects
None yet
Development

No branches or pull requests

4 participants