Skip to content
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

Add caveat about support for sync flags #560

Open
wants to merge 1 commit into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
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
19 changes: 15 additions & 4 deletions legacy/preview1/docs.md
Original file line number Diff line number Diff line change
Expand Up @@ -663,7 +663,11 @@ Append mode: Data written to the file is always appended to the file's end.
Bit: 0

- <a href="#fdflags.dsync" name="fdflags.dsync"></a> `dsync`: `bool`
Write according to synchronized I/O data integrity completion. Only the data stored in the file is synchronized.
Write according to synchronized I/O data integrity completion. Only the data
stored in the file is synchronized. This feature is not available on all
platforms and therefore [`path_open`](#path_open) and other such functions which
accept [`fdflags`](#fdflags) may return [`errno.notsup`](#errno.notsup) in the
case that this flag is set.

Bit: 1

Expand All @@ -674,13 +678,20 @@ Bit: 2

- <a href="#fdflags.rsync" name="fdflags.rsync"></a> `rsync`: `bool`
Synchronized read I/O operations.
This feature is not available on all platforms and therefore
[`path_open`](#path_open) and other such functions which accept
[`fdflags`](#fdflags) may return [`errno.notsup`](#errno.notsup) in the case
that this flag is set.

Bit: 3

- <a href="#fdflags.sync" name="fdflags.sync"></a> `sync`: `bool`
Write according to synchronized I/O file integrity completion. In
addition to synchronizing the data stored in the file, the implementation
may also synchronously update the file's metadata.
Write according to synchronized I/O file integrity completion. In addition to
synchronizing the data stored in the file, the implementation may also
synchronously update the file's metadata. This feature is not available on all
platforms and therefore [`path_open`](#path_open) and other such functions which
accept [`fdflags`](#fdflags) may return [`errno.notsup`](#errno.notsup) in the
case that this flag is set.

Bit: 4

Expand Down