Module opts

Source
Expand description

Contains the *Opts structs representing the optional arguments passsed to Neovim API functions.

Structs§

BufAttachOpts
Options passed to Buffer::attach.
BufAttachOptsBuilder
BufDeleteOpts
Options passed to Buffer::attach.
BufDeleteOptsBuilder
ClearAutocmdsOpts
Options passed to clear_autocmds().
ClearAutocmdsOptsBuilder
CmdOpts
Options passed to cmd.
CmdOptsBuilder
CreateAugroupOpts
Options passed to create_augroup().
CreateAugroupOptsBuilder
CreateAutocmdOpts
Options passed to create_autocmd().
CreateAutocmdOptsBuilder
CreateCommandOpts
Options passed to create_user_command and Buffer::create_user_command().
CreateCommandOptsBuilder
DecorationProviderOpts
Options passed to set_decoration_provider().
DecorationProviderOptsBuilder
EchoOpts
Options passed to echo().
EchoOptsBuilder
EvalStatuslineOpts
Options passed to eval_statusline().
EvalStatuslineOptsBuilder
ExecAutocmdsOpts
Options passed to exec_autocmds().
ExecAutocmdsOptsBuilder
ExecOpts
Option passed to exec2().
ExecOptsBuilder
GetAutocmdsOpts
Options passed to get_autocmds().
GetAutocmdsOptsBuilder
GetCommandsOpts
Options passed to Buffer::get_commands() and get_commands().
GetCommandsOptsBuilder
GetContextOpts
Options passed to get_context().
GetContextOptsBuilder
GetExtmarkByIdOpts
Options passed to Buffer::get_extmark_by_id().
GetExtmarkByIdOptsBuilder
GetExtmarksOpts
Options passed to Buffer::get_extmarks().
GetExtmarksOptsBuilder
GetHighlightOpts
Option passed to get_hl().
GetHighlightOptsBuilder
GetMarkOpts
Options passed to get_mark(). Currently unused.
GetMarkOptsBuilder
GetNamespaceOpts
Option passed to get_hl_ns().
GetNamespaceOptsBuilder
GetTextOpts
Options passed to Buffer::get_text(). Currently unused.
GetTextOptsBuilder
OpenTermOpts
Options passed to open_term().
OpenTermOptsBuilder
OptionOpts
Options passed to set_option_value().
OptionOptsBuilder
ParseCmdOpts
Options passed to parse_cmd(). Currently unused.
ParseCmdOptsBuilder
SelectPopupMenuItemOpts
Options passed to select_popupmenu_item(). Currently unused.
SelectPopupMenuItemOptsBuilder
SetExtmarkOpts
Options passed to Buffer::set_extmark().
SetExtmarkOptsBuilder
SetHighlightOpts
SetHighlightOptsBuilder
SetKeymapOpts
Options passed to Buffer::set_keymap() and set_keymap().
SetKeymapOptsBuilder
SetMarkOpts
Options passed to Buffer::set_mark(). Currently unused.
SetMarkOptsBuilder
WinTextHeightOpts
Option passed to Window::text_height().
WinTextHeightOptsBuilder

Enums§

OptionScope

Type Aliases§

DontSkipOnLines
The on_win callback can return false to skip the on_line callback for that window.
DontSkipRedrawCycle
The on_start callback can return false to disable the provider until the next redraw.
OnBufArgs
Arguments passed to the function registered to on_buf.
OnBytesArgs
Arguments passed to the callback registered to on_bytes.
OnChangedtickArgs
Arguments passed to the callback registered to on_changedtick.
OnDetachArgs
Arguments passed to the callback registered to on_detach.
OnEndArgs
Arguments passed to the function registered to on_end.
OnInputArgs
Arguments passed to the callback registered to on_input. The (a, b, c, d) tuple represents:
OnLineArgs
Arguments passed to the function registered to on_line.
OnLinesArgs
Arguments passed to the callback registered to on_lines.
OnReloadArgs
Arguments passed to the callback registered to on_reload.
OnStartArgs
Arguments passed to the function registered to on_start.
OnWinArgs
Arguments passed to the function registered to on_win.
ShouldDeleteAutocmd
ShouldDetach
All the registered callbacks can detach by returning true, as described in :h api-lua-detach.