-
Notifications
You must be signed in to change notification settings - Fork 13.4k
Add a warning to File about mutability. #48273
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Merged
Merged
Changes from 1 commit
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
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
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -81,9 +81,18 @@ use time::SystemTime; | |
/// # } | ||
/// ``` | ||
/// | ||
/// Note that, although read and write methods require a `&mut File`, because | ||
/// of the interfaces for [`Read`] and [`Write`], it is still possible to | ||
/// modify a file through a `&File`, either through methods that take `&File` | ||
/// or by retrieving a raw OS filehandle and modifying the file that way. | ||
/// Additionally, many operating systems allow concurrent modification of files | ||
/// by different processes. Care should be taken not to assume that holding a | ||
/// `&File` means that the file will not change. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. This is a bit of a nitpick, but could you please phrase this in active voice? "..., the holder of a "... Avoid assuming that holding a |
||
/// | ||
/// [`Seek`]: ../io/trait.Seek.html | ||
/// [`String`]: ../string/struct.String.html | ||
/// [`Read`]: ../io/trait.Read.html | ||
/// [`Write`]: ../io/trait.Write.html | ||
/// [`BufReader<R>`]: ../io/struct.BufReader.html | ||
#[stable(feature = "rust1", since = "1.0.0")] | ||
pub struct File { | ||
|
@@ -459,6 +468,9 @@ impl File { | |
/// # Ok(()) | ||
/// # } | ||
/// ``` | ||
/// | ||
/// Note that this method alters the content of the underlying file, even | ||
/// though it takes `&self` rather than `&mut self`. | ||
#[stable(feature = "rust1", since = "1.0.0")] | ||
pub fn set_len(&self, size: u64) -> io::Result<()> { | ||
self.inner.truncate(size) | ||
|
@@ -557,6 +569,9 @@ impl File { | |
/// # Ok(()) | ||
/// # } | ||
/// ``` | ||
/// | ||
/// Note that this method alters the permissions of the underlying file, | ||
/// even though it takes `&self` rather than `&mut self`. | ||
#[stable(feature = "set_permissions_atomic", since = "1.16.0")] | ||
pub fn set_permissions(&self, perm: Permissions) -> io::Result<()> { | ||
self.inner.set_permissions(perm.0) | ||
|
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.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"file handle"
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Or "underlying OS object", since on Linux it'd be a file descriptor.