net: clarify socket gets closed on drop#7526
Merged
Darksonn merged 1 commit intotokio-rs:masterfrom Aug 11, 2025
Merged
Conversation
Add a note like in std::net::TcpListener.
Darksonn
added
A-tokio
Darksonn
approved these changes
Aug 11, 2025
Member
Darksonn
left a comment
Darksonn
left a comment
There was a problem hiding this comment.
I would say it goes without saying that proper cleanup will happen, but I guess it doens't hurt to add to the docs.
Contributor
Author
|
@Darksonn I guess so, but when comparing the docs with the std counterpart which states it explicitly, it got me thinking if I'm missing some special cleanup that I need to keep in mind (I'm also new to rust). Thanks for the quick merge! |
Member
|
Thanks for the PR! |
Merged
This file contains hidden or 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
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
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.
Add a note like in std::net::TcpListener.
Motivation
I wasn't sure whether tokio TcpListener closes the connection on close, and had to look at the internals to figure out it just wraps a regular TcpListener. Also, I was using the crates warp->hyper and had to look all down the stack to see how the port is managed.
Solution
Added to the docs a note just like in
std::net::TcpListener