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

Missing documentation for feature time in crate tokio_util #3596

Closed
oddcoder opened this issue Mar 9, 2021 · 1 comment · Fixed by #3606
Closed

Missing documentation for feature time in crate tokio_util #3596

oddcoder opened this issue Mar 9, 2021 · 1 comment · Fixed by #3606
Labels
A-tokio-util Area: The tokio-util crate C-bug Category: This is a bug. E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. M-time Module: tokio/time

Comments

@oddcoder
Copy link

oddcoder commented Mar 9, 2021

Version
tokio ="1"
tokio-util = "0.6.3"

Platform
Windows 64 bit

Description
With this cargo.toml

tokio = { version = "1", features = ["net", "io-util"] }
tokio-util = "0.6.3"

I got the following error

2 | use tokio_util::time::DelayQueue;
  |                 ^^^^ could not find `time` in `tokio_util`

Turns out that there was feature for time, and I never read about in the documentation.
Maybe the docs need little help with that ? (or perhaps the feature should be enabled by default)

@oddcoder oddcoder added A-tokio Area: The main tokio crate C-bug Category: This is a bug. labels Mar 9, 2021
@Darksonn Darksonn added A-tokio-util Area: The tokio-util crate M-time Module: tokio/time and removed A-tokio Area: The main tokio crate labels Mar 9, 2021
@Darksonn
Copy link
Contributor

Darksonn commented Mar 9, 2021

The fix for this would be adding the appropriate annotations on the time module and DelayQueue type such that it gets marked in the documentation as requiring the time feature.

@Darksonn Darksonn added E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. labels Mar 9, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-tokio-util Area: The tokio-util crate C-bug Category: This is a bug. E-easy Call for participation: Experience needed to fix: Easy / not much E-help-wanted Call for participation: Help is requested to fix this issue. M-time Module: tokio/time
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants