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

try_skip_while and try_take_while have inaccurate doc comments (errors are passed through) #2476

Open
ttttcrngyblflpp opened this issue Aug 17, 2021 · 0 comments
Labels
A-stream Area: futures::stream docs

Comments

@ttttcrngyblflpp
Copy link

ttttcrngyblflpp commented Aug 17, 2021

The documentation of try_take_while states:

This function is similar to StreamExt::take_while but exits early if an error occurs.

The actual behavior is that errors are passed through. It seems like the wording should be changed to match, e.g. try_filter. try_skip_while has the same problem.

Alternatively, perhaps all TryStreamExt combinators which return a TryStream should actually not yield more than one error (this is possible, e.g. if selecting between two TryStreams).

@taiki-e taiki-e added docs A-stream Area: futures::stream labels Aug 28, 2021
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
A-stream Area: futures::stream docs
Projects
None yet
Development

No branches or pull requests

2 participants