Document how to close a stream correctly #1493
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
|
Good call on actually compiling the example, there were quite a few errors! I've left some EOF wording in there since I think that is the terminology when using stream I think. Let me know if you'd still like to remove this. |
Ralith
reviewed
Feb 17, 2023
|
Please take another look, I've adopted the suggested wording changes. |
Ralith
previously approved these changes
Feb 26, 2023
It is not trivial to correctly close a stream without errors and knowing everything is fully acknowledged. Describe some details around this.
Co-authored-by: Benjamin Saunders <ben.e.saunders@gmail.com>
Co-authored-by: Benjamin Saunders <ben.e.saunders@gmail.com>
Ralith
reviewed
Feb 27, 2023
Co-authored-by: Benjamin Saunders <ben.e.saunders@gmail.com>
Ralith
previously approved these changes
Feb 27, 2023
Ralith
reviewed
Feb 27, 2023
quinn/src/recv_stream.rs
Outdated
| /// let mut buf = [0u8; 10]; | ||
| /// let data = recv_stream.read_exact(&mut buf).await?; | ||
| /// if recv_stream.read_to_end(0).await.is_err() { | ||
| /// recv_stream.stop(0u8.into()).ok(); |
There was a problem hiding this comment.
Ah, of course this call is impossible because read_to_end takes ownership. Perhaps we should change it to take &mut self...
|
Apologies for just using the github suggestions and letting CI find the bugs, which is just painful and slow. I've fixed up the example locally and it all works again. I stuck with |
Ralith
approved these changes
Mar 1, 2023
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
It is not trivial to correctly close a stream without errors and knowing everything is fully acknowledged. Describe some details around this.