diff options
| author | Simon Kissane <skissane@gmail.com> | 2021-05-25 06:30:49 +1000 |
|---|---|---|
| committer | Jameson Nash <vtjnash@gmail.com> | 2021-05-24 16:32:41 -0400 |
| commit | 4cf638de0505035506521a5988193b9b8d94a281 (patch) | |
| tree | 481182305a4ec47b97c25127bdb2bc0056fab7dc /docs/src | |
| parent | 46451737e6174281317cabdf05c9ba1434c359d6 (diff) | |
| download | libuv-4cf638de0505035506521a5988193b9b8d94a281.tar.gz libuv-4cf638de0505035506521a5988193b9b8d94a281.zip | |
doc: uv_read_stop always succeeds
Fixes: https://github.com/libuv/libuv/issues/3041
PR-URL: https://github.com/libuv/libuv/pull/3076
Reviewed-By: Jameson Nash <vtjnash@gmail.com>
Diffstat (limited to 'docs/src')
| -rw-r--r-- | docs/src/stream.rst | 5 |
1 files changed, 5 insertions, 0 deletions
diff --git a/docs/src/stream.rst b/docs/src/stream.rst index 429ebdab..58ef7d98 100644 --- a/docs/src/stream.rst +++ b/docs/src/stream.rst @@ -151,6 +151,11 @@ API This function is idempotent and may be safely called on a stopped stream. + This function will always succeed; hence, checking its return value is + unnecessary. A non-zero return indicates that finishing releasing resources + may be pending on the next input event on that TTY on Windows, and does not + indicate failure. + .. c:function:: int uv_write(uv_write_t* req, uv_stream_t* handle, const uv_buf_t bufs[], unsigned int nbufs, uv_write_cb cb) Write data to stream. Buffers are written in order. Example: |