diff options
author | zhaozg <zhaozg@gmail.com> | 2023-08-25 21:52:13 +0800 |
---|---|---|
committer | Christian Clason <c.clason@uni-graz.at> | 2023-08-27 10:02:43 +0900 |
commit | c4728a5c4619a87b67720ca35225e2e45aaafccd (patch) | |
tree | 397c02cb5b76ac953d5b58a67cb5bed8b1378ab9 /runtime | |
parent | e8dd3fa280f44fa565533b70b37fbb688c54c5b5 (diff) | |
download | rneovim-c4728a5c4619a87b67720ca35225e2e45aaafccd.tar.gz rneovim-c4728a5c4619a87b67720ca35225e2e45aaafccd.tar.bz2 rneovim-c4728a5c4619a87b67720ca35225e2e45aaafccd.zip |
build(deps): bump luv to HEAD dcd1a1c
Diffstat (limited to 'runtime')
-rw-r--r-- | runtime/doc/luvref.txt | 76 |
1 files changed, 72 insertions, 4 deletions
diff --git a/runtime/doc/luvref.txt b/runtime/doc/luvref.txt index 8c842de97a..226e79b68b 100644 --- a/runtime/doc/luvref.txt +++ b/runtime/doc/luvref.txt @@ -3,7 +3,7 @@ LUV REFERENCE MANUAL - *luvref* + *luvref* This file documents the Lua bindings for the LibUV library which is used for Nvim's event-loop and is accessible from Lua via |vim.uv| (e.g., |uv.version()| is exposed as `vim.uv.version()`). @@ -1355,7 +1355,7 @@ uv.process_kill({process}, {signum}) *uv.process_kill()* Parameters: - `process`: `uv_process_t userdata` - - `signum`: `integer` or `string` + - `signum`: `integer` or `string` or `nil` (default: `sigterm`) Sends the specified signal to the given process handle. Check the documentation on |uv_signal_t| for signal support, @@ -1367,7 +1367,7 @@ uv.kill({pid}, {signum}) *uv.kill()* Parameters: - `pid`: `integer` - - `signum`: `integer` or `string` + - `signum`: `integer` or `string` or `nil` (default: `sigterm`) Sends the specified signal to the given PID. Check the documentation on |uv_signal_t| for signal support, specially @@ -2064,6 +2064,69 @@ uv.pipe({read_flags}, {write_flags}) *uv.pipe()* end) < +uv.pipe_bind2({pipe}, {name}, {flags}) *uv.pipe_bind2()* + + > method form `pipe:pipe_bind(name, flags)` + + Parameters: + - `pipe`: `uv_pipe_t userdata` + - `name`: `string` + - `flags`: `integer` or `table` or `nil`(default: 0) + + Flags: + - If `type(flags)` is `number`, it must be `0` or + `uv.constants.PIPE_NO_TRUNCATE`. + - If `type(flags)` is `table`, it must be `{}` or + `{ no_trunate = true|false }`. + - If `type(flags)` is `nil`, it use default value `0`. + - Returns `EINVAL` for unsupported flags without performing the + bind. + + Bind the pipe to a file path (Unix) or a name (Windows). + + Supports Linux abstract namespace sockets. namelen must include + the leading '\0' byte but not the trailing nul byte. + + Returns: `0` or `fail` + + *Note*: + 1. Paths on Unix get truncated to sizeof(sockaddr_un.sun_path) + bytes, typically between 92 and 108 bytes. + 2. New in version 1.46.0. + +uv.pipe_connect2(pipe, name, [flags], [callback]) *uv.pipe_connect2()* + + > method form `pipe:connect2(name, [flags], [callback])` + + Parameters: + - `pipe`: `uv_pipe_t userdata` + - `name`: `string` + - `flags`: `integer` or `table` or `nil`(default: 0) + - `callback`: `callable` or `nil` + - `err`: `nil` or `string` + + `Flags`: + + - If `type(flags)` is `number`, it must be `0` or + `uv.constants.PIPE_NO_TRUNCATE`. + - If `type(flags)` is `table`, it must be `{}` or + `{ no_trunate = true|false }`. + - If `type(flags)` is `nil`, it use default value `0`. + - Returns `EINVAL` for unsupported flags without performing the + bind operation. + + Connect to the Unix domain socket or the named pipe. + + Supports Linux abstract namespace sockets. namelen must include + the leading nul byte but not the trailing nul byte. + + Returns: `uv_connect_t userdata` or `fail` + + *Note*: + 1. Paths on Unix get truncated to sizeof(sockaddr_un.sun_path) + bytes, typically between 92 and 108 bytes. + 2. New in version 1.46.0. + ============================================================================== `uv_tty_t` — TTY handle *luv-tty-handle* *uv_tty_t* @@ -3950,7 +4013,12 @@ uv.os_setenv({name}, {value}) *uv.os_setenv()* WARNING: This function is not thread safe. -uv.os_unsetenv() *uv.os_unsetenv()* +uv.os_unsetenv({name}) *uv.os_unsetenv()* + + Parameters: + - `name`: `string` + + Unsets the environmental variable specified by `name`. Returns: `boolean` or `fail` |