Expand description
Contains the *Opts structs representing the optional arguments
passsed to Neovim API functions.
Structs§
- BufAttach
Opts - Options passed to
Buffer::attach. - BufAttach
Opts Builder - Builder for
BufAttachOpts. - BufDelete
Opts - Options passed to
Buffer::delete. - BufDelete
Opts Builder - Builder for
BufDeleteOpts. - Clear
Autocmds Opts - Options passed to
api::clear_autocmds. - Clear
Autocmds Opts Builder - Builder for
ClearAutocmdsOpts. - CmdOpts
- Options passed to
api::cmd. - CmdOpts
Builder - Builder for
CmdOpts. - Create
Augroup Opts - Options passed to
crate::api::create_augroup. - Create
Augroup Opts Builder - Builder for
CreateAugroupOpts. - Create
Autocmd Opts - Options passed to
crate::create_autocmd. - Create
Autocmd Opts Builder - Builder for
CreateAutocmdOpts. - Create
Command Opts - Options passed to
Buffer::create_user_command. - Create
Command Opts Builder - Builder for
CreateCommandOpts. - Decoration
Provider Opts - Options passed to
nvim_oxi::api::set_decoration_provider. - Decoration
Provider Opts Builder - Builder for
DecorationProviderOpts. - Eval
Statusline Opts - Options passed to
api::eval_statusline. - Eval
Statusline Opts Builder - Builder for
EvalStatuslineOpts. - Exec
Autocmds Opts - Options passed to
api::exec_autocmds. - Exec
Autocmds Opts Builder - Builder for
ExecAutocmdsOpts. - GetAutocmds
Opts - Options passed to
nvim_oxi::api::get_autocmds. - GetAutocmds
Opts Builder - Builder for
GetAutocmdsOpts. - GetCommands
Opts - Options passed to
Buffer::get_commandsandget_commands. - GetCommands
Opts Builder - Builder for
GetCommandsOpts. - GetContext
Opts - Options passed to
api::get_context. - GetContext
Opts Builder - Builder for
GetContextOpts. - GetExtmark
ById Opts - Options passed to
Buffer::get_extmark_by_id. - GetExtmark
ById Opts Builder - Builder for
GetExtmarkByIdOpts. - GetExtmarks
Opts - Options passed to
Buffer::get_extmarks. - GetExtmarks
Opts Builder - Builder for
GetExtmarksOpts. - GetMark
Opts - Options passed to
api::get_mark. Currently unused. - GetMark
Opts Builder - Builder for
GetMarkOpts. - GetText
Opts - Options passed to
Buffer::get_text. Currently unused. - GetText
Opts Builder - Builder for
GetTextOpts. - Notify
Opts - Options passed to
notify. Currently unused. - Notify
Opts Builder - Builder for
NotifyOpts. - Open
Term Opts - Open
Term Opts Builder - Builder for
OpenTermOpts. - Option
Value Opts - Options passed to
nvim_oxi::api::set_option_value. - Option
Value Opts Builder - Builder for
OptionValueOpts. - Select
Popup Menu Item Opts - Options passed to
api::select_popupmenu_item. Currently unused. - Select
Popup Menu Item Opts Builder - Builder for
SelectPopupMenuItemOpts. - SetExtmark
Opts - SetExtmark
Opts Builder - SetHighlight
Opts - Options passed to
nvim_oxi::api::set_hl. - SetHighlight
Opts Builder - Builder for
SetHighlightOpts. - SetKeymap
Opts - Options passed to
Buffer::set_keymapandapi::set_keymap. - SetKeymap
Opts Builder - Builder for
SetKeymapOpts.
Enums§
- BufAttach
Opts Builder Error - Error type for BufAttachOptsBuilder
- BufDelete
Opts Builder Error - Error type for BufDeleteOptsBuilder
- Clear
Autocmds Opts Builder Error - Error type for ClearAutocmdsOptsBuilder
- CmdOpts
Builder Error - Error type for CmdOptsBuilder
- Create
Augroup Opts Builder Error - Error type for CreateAugroupOptsBuilder
- Create
Autocmd Opts Builder Error - Error type for CreateAutocmdOptsBuilder
- Create
Command Opts Builder Error - Error type for CreateCommandOptsBuilder
- Decoration
Provider Opts Builder Error - Error type for DecorationProviderOptsBuilder
- Eval
Statusline Opts Builder Error - Error type for EvalStatuslineOptsBuilder
- Exec
Autocmds Opts Builder Error - Error type for ExecAutocmdsOptsBuilder
- GetAutocmds
Opts Builder Error - Error type for GetAutocmdsOptsBuilder
- GetCommands
Opts Builder Error - Error type for GetCommandsOptsBuilder
- GetContext
Opts Builder Error - Error type for GetContextOptsBuilder
- GetExtmark
ById Opts Builder Error - Error type for GetExtmarkByIdOptsBuilder
- GetExtmarks
Opts Builder Error - Error type for GetExtmarksOptsBuilder
- GetMark
Opts Builder Error - Error type for GetMarkOptsBuilder
- GetText
Opts Builder Error - Error type for GetTextOptsBuilder
- Notify
Opts Builder Error - Error type for NotifyOptsBuilder
- Open
Term Opts Builder Error - Error type for OpenTermOptsBuilder
- Option
Scope - Option
Value Opts Builder Error - Error type for OptionValueOptsBuilder
- Select
Popup Menu Item Opts Builder Error - Error type for SelectPopupMenuItemOptsBuilder
- SetHighlight
Opts Builder Error - Error type for SetHighlightOptsBuilder
- SetKeymap
Opts Builder Error - Error type for SetKeymapOptsBuilder
Type Aliases§
- Dont
Skip OnLines - The
on_wincallback can returnfalseto skip theon_linecallback for that window. - Dont
Skip Redraw Cycle - The
on_startcallback can returnfalseto disable the provider until the next redraw. - OnBuf
Args - Arguments passed to the function registered to
on_buf. - OnBytes
Args - Arguments passed to the callback registered to
on_bytes. The(a, b, c, d, e, f, g, h, i, j, k, l) - OnChangedtick
Args - Arguments passed to the callback registered to
on_changedtick. The first tuple element is the string literal"changedtick", the second is theBufferthat triggered the callback and the third is current value of the buffer-localb:changedtickvariable. - OnDetach
Args - Arguments passed to the callback registered to
on_detach. The first tuple element is the string literal"detach", the second is theBufferthat triggered the callback. - OnEnd
Args - Arguments passed to the function registered to
on_end. - OnInput
Args - Arguments passed to the callback registered to
on_input. The(a, b, c, d)tuple represents: - OnLine
Args - Arguments passed to the function registered to
on_line. - OnLines
Args - Arguments passed to the callback registered to
on_lines. The(a, b, c, d, e, f, g, h, i)tuple represents: - OnReload
Args - Arguments passed to the callback registered to
on_reload. The first tuple element is the string literal"reload", the second is theBufferthat triggered the callback. - OnStart
Args - Arguments passed to the function registered to
on_start. - OnWin
Args - Arguments passed to the function registered to
on_win. - Should
Delete Autocmd - Should
Detach - All the registered callbacks can detach by returning
true, as described in:h api-lua-detach.