Document that File does not buffer reads/writes, refer to BufReader/BufWriter
This commit is contained in:
parent
57ad5058d6
commit
5cbe41ae9e
@ -31,6 +31,10 @@ use crate::time::SystemTime;
|
|||||||
/// on closing are ignored by the implementation of `Drop`. Use the method
|
/// on closing are ignored by the implementation of `Drop`. Use the method
|
||||||
/// [`sync_all`] if these errors must be manually handled.
|
/// [`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
|
/// # Examples
|
||||||
///
|
///
|
||||||
/// Creates a new file and write bytes to it (you can also use [`write()`]):
|
/// Creates a new file and write bytes to it (you can also use [`write()`]):
|
||||||
@ -61,8 +65,7 @@ use crate::time::SystemTime;
|
|||||||
/// }
|
/// }
|
||||||
/// ```
|
/// ```
|
||||||
///
|
///
|
||||||
/// It can be more efficient to read the contents of a file with a buffered
|
/// Using a buffered [`Read`]er:
|
||||||
/// [`Read`]er. This can be accomplished with [`BufReader<R>`]:
|
|
||||||
///
|
///
|
||||||
/// ```no_run
|
/// ```no_run
|
||||||
/// use std::fs::File;
|
/// use std::fs::File;
|
||||||
@ -93,8 +96,11 @@ use crate::time::SystemTime;
|
|||||||
/// perform synchronous I/O operations. Therefore the underlying file must not
|
/// 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`).
|
/// 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
|
/// [`sync_all`]: File::sync_all
|
||||||
|
/// [`write`]: File::write
|
||||||
|
/// [`read`]: File::read
|
||||||
#[stable(feature = "rust1", since = "1.0.0")]
|
#[stable(feature = "rust1", since = "1.0.0")]
|
||||||
#[cfg_attr(not(test), rustc_diagnostic_item = "File")]
|
#[cfg_attr(not(test), rustc_diagnostic_item = "File")]
|
||||||
pub struct File {
|
pub struct File {
|
||||||
|
Loading…
x
Reference in New Issue
Block a user