luo980/libuv
1
0
Fork 0
Code Issues Pull Requests Actions Packages Projects Releases Wiki Activity

doc: clarify uv_fs_t.result

Browse Source
This commit is contained in:
Saúl Ibarra Corretgé 2024-05-30 09:19:05 +02:00
parent 541329d51f
commit b61ba4635d
1 changed files with 11 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

14
docs/src/fs.rst
View File

@ -190,9 +190,13 @@ Public members
.. c:member:: ssize_t uv_fs_t.result
Result of the request. < 0 means error, success otherwise. On requests such
as :c:func:`uv_fs_read` or :c:func:`uv_fs_write` it indicates the amount of
data that was read or written, respectively.
Result of the request. < 0 means error, success otherwise. This field is always set, regardless
of the request being sync or async.
For synchronous calls, the result of each operation is this field.
Check each function's documentation to check if the field has
an extended meaning.
.. c:member:: uv_stat_t uv_fs_t.statbuf
@ -232,6 +236,8 @@ API
Equivalent to :man:`preadv(2)`. If the `offset` argument is `-1`, then
the current file offset is used and updated.
The result in `req->result` indicates the amount of bytes read, if > 0.
.. warning::
On Windows, under non-MSVC environments (e.g. when GCC or Clang is used
to build libuv), files opened using ``UV_FS_O_FILEMAP`` may cause a fatal
@ -246,6 +252,8 @@ API
Equivalent to :man:`pwritev(2)`. If the `offset` argument is `-1`, then
the current file offset is used and updated.
The result in `req->result` indicates the amount of bytes written, if > 0.
.. warning::
On Windows, under non-MSVC environments (e.g. when GCC or Clang is used
to build libuv), files opened using ``UV_FS_O_FILEMAP`` may cause a fatal