Add try_*, readable, writable, ready, and peer_addr methods to TCP and Unix split halves #4120
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
…d unix split halves Also adds a doc test to UnixStream::peer_addr().
|
This should resolve #4098 |
|
I decided it wouldn't make a ton of sense not to just add the local_addr method as well, since I'm already adding peer_addr. |
Darksonn
reviewed
Sep 20, 2021
Darksonn
reviewed
Sep 20, 2021
Darksonn
reviewed
Sep 20, 2021
|
Honestly, now that I see how massive this change is, I wonder if we should change course and instead write some documentation that explains how you can call methods on the underlying IO resource. |
|
Every time we've added a new |
|
I've removed the examples, it's no longer nearly as large of a change |
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
|
@Darksonn I've gone through and addressed the documentation issues. |
Darksonn
reviewed
Sep 25, 2021
Co-authored-by: Alice Ryhl <aliceryhl@google.com>
…h/read-write-halves
suikammd
pushed a commit
to suikammd/tokio
that referenced
this pull request
Oct 7, 2021
…thods to split halves (tokio-rs#4120)
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.
Motivation
Currently, Tokio's split halves APIs leave out a lot of fairly useful methods from TcpStream and UnixStream.
Solution
This PR adds the try_*, readable, writable, ready, and peer_addr methods to the split halves APIs for TcpStream and UnixStream.
This PR also adds a doc example for the UnixStream-related peer_addr methods.
Closes: #4098