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

Jump to bottom

Document cancel safety of `StreamExt::next` #2701

Open

bonsairobo opened this issue Jan 31, 2023 · 1 comment · May be fixed by #2896

Labels

docs

bonsairobo commented Jan 31, 2023

Here: https://docs.rs/futures/latest/futures/stream/trait.StreamExt.html#method.next

And the equivalent tokio docs: https://docs.rs/tokio-stream/latest/tokio_stream/trait.StreamExt.html#method.next

I think it's critical that users know if stream items can be accidentally dropped if the future is cancelled.

taiki-e added the docs label

Member

taiki-e commented Jan 31, 2023

I would accept a PR to document this.

akonradi-signal linked a pull request

that will close this issue

Document cancel-safety of StreamExt::next #2896

Open

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment