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

tokio::signal::unix::Signal missing Stream impl, poll methods are left undocumented #1848

Closed
osa1 opened this issue Nov 28, 2019 · 5 comments
Assignees

Comments

@osa1
Copy link
Contributor

osa1 commented Nov 28, 2019

Version

0.2.1, git HEAD

Description

tokio::signal::unix::Signal used to be a Stream but with 0.2.1 the Stream implementation is gone. The documentation still says it's a Stream ("An implementation of Stream for receiving a particular type of signal."). Just chatted with @carllerche on gitter about this and it seems like this impl should still be there.

Another issue is with the hidden recv and poll_recv methods: https://github.com/tokio-rs/tokio/blob/master/tokio/src/signal/unix.rs#L393-L405 apparently those should be documented and exposed.

@ipetkov
Copy link
Member

ipetkov commented Nov 28, 2019

Hey @osa1 thanks for catching this! I had meant to address this, but got busy and missed the release 😅

Fixing the docs should be straightforward enough

@osa1
Copy link
Contributor Author

osa1 commented Nov 28, 2019

@ipetkov Now that #1849 is merged would it be possible to release a new version after fixing the docs?

@ipetkov
Copy link
Member

ipetkov commented Nov 28, 2019

@osa1 yep that's the plan!

I've opened #1854 to fix the documentation, will work on scheduling a release after it lands

@osa1
Copy link
Contributor Author

osa1 commented Nov 29, 2019

It seems like both issues are fixed now. Should we close this?

@ipetkov
Copy link
Member

ipetkov commented Nov 29, 2019

I've opened #1857 to prepare for the next release, so will close this!

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

2 participants