bjoernager/rust
bjoernager/rust
1
Fork 0
Code Activity

Document synchronicity

Browse source
This commit is contained in:
Chris Denton 2022-03-30 12:36:00 +01:00
parent 36aa75e44d
commit 084b71a54f
No known key found for this signature in database
GPG key ID: 713472F2F45627DE
1 changed files with 6 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

6
library/std/src/fs.rs
View file

@ -85,6 +85,12 @@ use crate::time::SystemTime;
/// by different processes. Avoid assuming that holding a `&File` means that the /// by different processes. Avoid assuming that holding a `&File` means that the
/// file will not change. /// file will not change.
/// ///
/// # Platform-specific behavior
///
/// On Windows, the implementation of [`Read`] and [`Write`] traits for `File`
/// 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<R>`]: io::BufReader
/// [`sync_all`]: File::sync_all /// [`sync_all`]: File::sync_all
#[stable(feature = "rust1", since = "1.0.0")] #[stable(feature = "rust1", since = "1.0.0")]