Expand description
This module contains the bindings to the Neovim
API, exposed in Lua through the
vim.api table.
§Naming convention
All the functions have been renamed by dropping the leading nvim_ prefix,
e.g. nvim_get_current_buf simply becomes get_current_buf.
Also, the functions starting with nvim_buf_*, nvim_win_* and
nvim_tabpage_* are implemented as methods on the Buffer, Window
and TabPage objects respectively.
Modules§
- opts
- Contains the
*Optsstructs representing the optional arguments passsed to Neovim API functions. - types
- Contains various types given to and returned from Neovim API functions.
Structs§
- Buffer
- A wrapper around a Neovim buffer handle.
- TabPage
- A wrapper around a Neovim tab handle.
- Window
- A wrapper around a Neovim window handle.
Enums§
Traits§
- String
OrFunction - A Rust closure, a
Functionor a string. - String
OrInt - A string or an integer.
- String
OrList OfStrings - A string or a list of strings.
- ToFunction
- A Rust closure or a
Function.
Functions§
- call_
dict_ function - Binding to
nvim_call_dict_function. - call_
function - Binding to
nvim_call_function. - chan_
send - Binding to
nvim_chan_send. - clear_
autocmds - Binding to
nvim_clear_autocmds. - command
- Binding to
nvim_command. - create_
augroup - Binding to
nvim_create_augroup. - create_
autocmd - Binding to
nvim_create_autocmd. - create_
buf - Binding to
nvim_create_buf. - create_
namespace - Binding to
nvim_create_namespace. - create_
user_ command - Binding to
nvim_create_user_command. - del_
augroup_ by_ id - Binding to
nvim_del_augroup_by_id. - del_
augroup_ by_ name - Binding to
nvim_del_augroup_by_name. - del_
autocmd - Binding to
nvim_del_autocmd. - del_
current_ line - Binding to
nvim_del_current_line. - del_
keymap - Binding to
nvim_del_keymap. - del_
mark - Binding to
nvim_del_mark. - del_
user_ command - Binding to
nvim_del_user_command. - del_var
- Binding to
nvim_del_var. - echo
- Binding to
nvim_echo. - err_
write - Binding to
nvim_err_write. - err_
writeln - Binding to
nvim_err_writeln. - eval
- Binding to
nvim_eval. - eval_
statusline - Binding to
nvim_eval_statusline. - exec
- Binding to
nvim_exec. - exec_
autocmds - Binding to
nvim_exec_autocmds. - feedkeys
- Binding to
nvim_feedkeys. - get_
all_ options_ info - Binding to
nvim_get_all_options_info. - get_
autocmds - Binding to
nvim_get_autocmds. - get_
chan_ info - Binding to
nvim_get_chan_info. - get_
color_ by_ name - Binding to
nvim_get_color_by_name. - get_
color_ map - Binding to
nvim_get_color_map. - get_
commands - Binding to
nvim_get_commands. - get_
context - Binding to
nvim_get_context. - get_
current_ buf - Binding to
nvim_get_current_buf. - get_
current_ line - Binding to
nvim_get_current_line. - get_
current_ tabpage - Binding to
nvim_get_current_tabpage. - get_
current_ win - Binding to
nvim_get_current_win. - get_
hl_ by_ id - Binding to
nvim_get_hl_by_id. - get_
hl_ by_ name - Binding to
nvim_get_hl_by_name. - get_
hl_ id_ by_ name - Binding to
nvim_get_hl_id_by_name. - get_
keymap - Binding to
nvim_get_keymap. - get_
mark - Binding to
nvim_get_mark. - get_
mode - Binding to
nvim_get_mode. - get_
namespaces - Binding to
nvim_get_namespaces. - get_
option - Binding to
nvim_get_option. - get_
option_ info - Binding to
nvim_get_option_info. - get_
option_ value - Binding to
nvim_get_option_value. - get_
proc - Binding to
nvim_get_proc. - get_
proc_ children - Binding to
nvim_get_proc_children. - get_
runtime_ file - Binding to
nvim_get_runtime_file. - get_var
- Binding to
nvim_get_var. - get_
vvar - Binding to
nvim_get_vvar. - input
- Binding to
nvim_input. - input_
mouse - Binding to
nvim_input_mouse. - list_
bufs - Binding to
nvim_list_bufs. - list_
chans - Binding to
nvim_list_chans. - list_
runtime_ paths - Binding to
nvim_list_runtime_paths. - list_
tabpages - Binding to
nvim_list_bufs. - list_
uis - Binding to
nvim_list_uis. - list_
wins - Binding to
nvim_list_wins. - load_
context - Binding to
nvim_load_context. - notify
- Binding to
nvim_notify. - open_
term - Binding to
nvim_open_term. - open_
win - Binding to
nvim_open_win. - out_
write - Binding to
nvim_out_write. - parse_
expression - Binding to
nvim_parse_expression. - paste
- Binding to
nvim_paste. - put
- Binding to
nvim_put. - replace_
termcodes - Binding to
nvim_replace_termcodes. - select_
popupmenu_ item - Binding to
nvim_select_popupmenu_item. - set_
current_ buf - Binding to
nvim_set_current_buf. - set_
current_ dir - Binding to
nvim_set_current_dir. - set_
current_ line - Binding to
nvim_set_current_line. - set_
current_ tabpage - Binding to
nvim_set_current_tabpage. - set_
current_ win - Binding to
nvim_set_current_win. - set_
decoration_ provider - Binding to
nvim_set_decoration_provider. - set_hl
- Binding to
nvim_set_hl. - set_
keymap - Binding to
nvim_set_keymap. - set_
option - Binding to
nvim_set_option. - set_
option_ value - Binding to
nvim_set_option_value. - set_var
- Binding to
nvim_set_var. - set_
vvar - Binding to
nvim_set_vvar. - strwidth
- Binding to
nvim_strwidth.