docs: add cancel safety section to TcpStream::peek #7305
Conversation
|
cc @maminrayej |
tokio/src/net/tcp/stream.rs
Outdated
| /// # Cancel safety | ||
| /// | ||
| /// This method is cancel safe, as no underlying state gets modified. | ||
| /// |
There was a problem hiding this comment.
Let's stay consistent with the wording that is used throughout the code base for documenting cancel safety:
This method is cancel safe. If the method is used as the event in a tokio::select! statement and some other branch completes first, then it is guaranteed that <insert the appropriate text here>.
For example for TcpListener::accept, it's:
This method is cancel safe. If the method is used as the event in a tokio::select! statement and some other branch completes first, then it is guaranteed that no new connections were accepted by this method.
There was a problem hiding this comment.
The link to tokio::select! isn't working. You need to mark the link properly. See the other examples of how to say where the link should go.
Darksonn
added
T-docs
|
updated to reflect the suggestion. |
| /// This method is cancel safe. If the method is used as the event in a | ||
| /// [`tokio::select!`] statement and some other branch completes first, | ||
| /// then it is guranteed that no data was permanently read from the | ||
| /// stream's buffer. |
There was a problem hiding this comment.
Hmm. Unlike read, peek never reads data permanently even if you let it complete.
| /// This method is cancel safe. If the method is used as the event in a | |
| /// [`tokio::select!`] statement and some other branch completes first, | |
| /// then it is guranteed that no data was permanently read from the | |
| /// stream's buffer. | |
| /// This method is cancel safe. If the method is used as the event in a | |
| /// [`tokio::select!`] statement and some other branch completes first, | |
| /// then it is guranteed that no peek was performed, and that `buf` | |
| /// has not been modified. |
Fix #7303