Thanks to visit codestin.com
Credit goes to github.com

Skip to content

Document that File does not buffer reads/writes #119319

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.

Sign up for GitHub

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 1 commit into from
Jan 3, 2024
Merged

Document that File does not buffer reads/writes #119319

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Document that File does not buffer reads/writes, refer to BufReader/B… 
…ufWriter
  • Loading branch information
@chfogelman
chfogelman committed Jan 1, 2024
commit 5cbe41ae9e1058eb143adecccc2e12c622b67342
12 changes: 9 additions & 3 deletions library/std/src/fs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,6 +31,10 @@ use crate::time::SystemTime;
/// on closing are ignored by the implementation of `Drop`. Use the method
/// [`sync_all`] if these errors must be manually handled.
///
/// `File` does not buffer reads and writes. For efficiency, consider wrapping the
/// file in a [`BufReader`] or [`BufWriter`] when performing many small [`read`]
/// or [`write`] calls, unless unbuffered reads and writes are required.
///
/// # Examples
///
/// Creates a new file and write bytes to it (you can also use [`write()`]):
Expand Down Expand Up @@ -61,8 +65,7 @@ use crate::time::SystemTime;
/// }
/// ```
///
/// It can be more efficient to read the contents of a file with a buffered
/// [`Read`]er. This can be accomplished with [`BufReader<R>`]:
/// Using a buffered [`Read`]er:
///
/// ```no_run
/// use std::fs::File;
Expand Down Expand Up @@ -93,8 +96,11 @@ use crate::time::SystemTime;
/// perform synchronous I/O operations. Therefore the underlying file must not
/// have been opened for asynchronous I/O (e.g. by using `FILE_FLAG_OVERLAPPED`).
///
/// [`BufReader<R>`]: io::BufReader
/// [`BufReader`]: io::BufReader
/// [`BufWriter`]: io::BufReader
/// [`sync_all`]: File::sync_all
/// [`write`]: File::write
/// [`read`]: File::read
#[stable(feature = "rust1", since = "1.0.0")]
#[cfg_attr(not(test), rustc_diagnostic_item = "File")]
pub struct File {
Expand Down