updated description of File struct in std::fs #101385
Merged
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.
I've seen several folks confused by the description of
std::fs::File
as "A reference to an open file on the filesystem." Apparently the wordreference
is sometimes taken to mean a Rust&
reference, leading to confusion. Here's a recent representative Reddit thread, but I've seen this before as well.This patch changes the description to "An object providing access to an open file on the filesystem." Hopefully this is clearer.