Skip to content

fix docs & example for std::os::unix::prelude::FileExt::write_at #113876

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 2 commits into from
Jul 22, 2023
Merged

fix docs & example for std::os::unix::prelude::FileExt::write_at #113876

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
e7dc177
fix docs & example for FileExt::write_at
darklyspaced Jul 20, 2023
7d17a26
added a problematic example
darklyspaced Jul 20, 2023
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
9 changes: 8 additions & 1 deletion library/std/src/os/unix/fs.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -149,7 +149,14 @@ pub trait FileExt {
/// Note that similar to [`File::write`], it is not an error to return a
/// short write.
///
/// # Bug
/// On some systems, due to a [bug] with [`pwrite64`] (the underlying
/// syscall), files opened with the `O_APPEND` flag fail to respect the
/// offset parameter, always appending to the end of the file instead.
///
/// [`File::write`]: fs::File::write
/// [`pwrite64`]: https://man7.org/linux/man-pages/man2/pwrite.2.html
/// [bug]: https://man7.org/linux/man-pages/man2/pwrite.2.html#BUGS
///
/// # Examples
///
Expand All @@ -159,7 +166,7 @@ pub trait FileExt {
/// use std::os::unix::prelude::FileExt;
///
/// fn main() -> io::Result<()> {
/// let file = File::open("foo.txt")?;
/// let file = File::create("foo.txt")?;
///
/// // We now write at the offset 10.
/// file.write_at(b"sushi", 10)?;
Expand Down