mirror of
https://github.com/neovim/neovim.git
synced 2026-09-04 21:30:35 +00:00
ce8a897f98
Problem: Nvim has many Lua APIs that start callback-driven work: timers, jobs, libuv handles, and other event-loop tasks. Callers that need to sequence or cancel that work have to build their own coroutine wrappers, task bookkeeping, and cleanup rules. This makes async control flow hard to share, test, and document. Solution: Add `vim.async`, a structured-concurrency module vendored from async.nvim. It provides task handles, await/pawait helpers, sleep/timeout helpers, completion-order iteration, and semaphores on top of Nvim's event loop. The API follows the same broad model as Trio: async work has an owner, tasks are awaited explicitly, and cancellation is cooperative. Include generated vimdoc with an introductory overview and examples, a news entry, and functional tests for the new module. AI-assisted
108 lines
4.5 KiB
Lua
108 lines
4.5 KiB
Lua
--- @meta
|
|
-- This file is NOT generated, edit it directly.
|
|
error('Cannot require a meta file')
|
|
|
|
--- @alias elem_or_list<T> T|T[]
|
|
|
|
---@type uv
|
|
vim.uv = ...
|
|
|
|
--- LuaLS fallback surface for the richer iterator annotations in `vim.iter`.
|
|
--- EmmyLua reads the precise generics from `runtime/lua/vim/iter.lua`; LuaLS uses
|
|
--- these broader shapes for downstream type-checking.
|
|
--- @class vim.Iter
|
|
--- @field all fun(self: vim.Iter, pred: fun(...): boolean): boolean
|
|
--- @field any fun(self: vim.Iter, pred: fun(...): boolean): boolean
|
|
--- @field count fun(self: vim.Iter): integer
|
|
--- @field each fun(self: vim.Iter, f: fun(...)): nil
|
|
--- @field enumerate fun(self: vim.Iter): vim.Iter
|
|
--- @field filter fun(self: vim.Iter, f: fun(...): boolean): vim.Iter
|
|
--- @field find fun(self: vim.Iter, f: any): any
|
|
--- @field flatten fun(self: vim.Iter, depth?: integer): vim.IterArray
|
|
--- @field fold fun(self: vim.Iter, init: any, f: fun(acc: any, ...): any): any
|
|
--- @field join fun(self: vim.Iter, delim: string): string
|
|
--- @field last fun(self: vim.Iter): any
|
|
--- @field map fun(self: vim.Iter, f: fun(...): ...): vim.Iter
|
|
--- @field next fun(self: vim.Iter): any
|
|
--- @field nth fun(self: vim.Iter, n: integer): any
|
|
--- @field peek fun(self: vim.Iter): any
|
|
--- @field pop fun(self: vim.Iter): any
|
|
--- @field rev fun(self: vim.Iter): vim.IterArray
|
|
--- @field rfind fun(self: vim.Iter, f: any): any
|
|
--- @field rpeek fun(self: vim.Iter): any
|
|
--- @field rskip fun(self: vim.Iter, n: integer): vim.IterArray
|
|
--- @field skip fun(self: vim.Iter, n: integer|fun(...): boolean): vim.Iter
|
|
--- @field slice fun(self: vim.Iter, first: integer, last: integer): vim.IterArray
|
|
--- @field take fun(self: vim.Iter, n: integer|fun(...): boolean): vim.Iter
|
|
--- @field totable fun(self: vim.Iter): table
|
|
--- @field unique fun(self: vim.Iter, key?: fun(...): any): vim.Iter
|
|
|
|
--- @class vim.IterArray : vim.Iter
|
|
--- @field count fun(self: vim.IterArray): integer
|
|
--- @field enumerate fun(self: vim.IterArray): vim.IterArray
|
|
--- @field filter fun(self: vim.IterArray, f: fun(...): boolean): vim.IterArray
|
|
--- @field find fun(self: vim.IterArray, f: any): any
|
|
--- @field flatten fun(self: vim.IterArray, depth?: integer): vim.IterArray
|
|
--- @field fold fun(self: vim.IterArray, init: any, f: fun(acc: any, ...): any): any
|
|
--- @field last fun(self: vim.IterArray): any
|
|
--- @field map fun(self: vim.IterArray, f: fun(...): ...): vim.IterArray
|
|
--- @field next fun(self: vim.IterArray): any
|
|
--- @field peek fun(self: vim.IterArray): any
|
|
--- @field pop fun(self: vim.IterArray): any
|
|
--- @field rev fun(self: vim.IterArray): vim.IterArray
|
|
--- @field rfind fun(self: vim.IterArray, f: any): any
|
|
--- @field rpeek fun(self: vim.IterArray): any
|
|
--- @field rskip fun(self: vim.IterArray, n: integer): vim.IterArray
|
|
--- @field skip fun(self: vim.IterArray, n: integer|fun(...): boolean): vim.IterArray
|
|
--- @field slice fun(self: vim.IterArray, first: integer, last: integer): vim.IterArray
|
|
--- @field take fun(self: vim.IterArray, n: integer|fun(...): boolean): vim.IterArray
|
|
--- @field totable fun(self: vim.IterArray): table
|
|
--- @field unique fun(self: vim.IterArray, key?: fun(...): any): vim.IterArray
|
|
|
|
--- @class vim.IterModule
|
|
--- @operator call: fun(src: any, ...): vim.Iter
|
|
|
|
--- The following modules are loaded specially in _init_packages.lua
|
|
|
|
vim.F = require('vim.F')
|
|
vim._watch = require('vim._watch')
|
|
---@diagnostic disable-next-line: no-unknown
|
|
vim.async = require('vim.async')
|
|
vim.diagnostic = require('vim.diagnostic')
|
|
vim.filetype = require('vim.filetype')
|
|
vim.fs = require('vim.fs')
|
|
vim.func = require('vim.func')
|
|
vim.glob = require('vim.glob')
|
|
vim.health = require('vim.health')
|
|
vim.hl = require('vim.hl')
|
|
local iter = require('vim.iter')
|
|
-- `require('vim.iter')` carries the richer EmmyLua generic surface. Force
|
|
-- LuaLS onto the fallback module shape above so `make luals` stays clean.
|
|
---@cast iter vim.IterModule
|
|
vim.iter = iter
|
|
vim.keymap = require('vim.keymap')
|
|
vim.loader = require('vim.loader')
|
|
vim.log = require('vim.log')
|
|
vim.lsp = require('vim.lsp')
|
|
vim.net = require('vim.net')
|
|
vim.pack = require('vim.pack')
|
|
vim.pos = require('vim.pos')
|
|
vim.range = require('vim.range')
|
|
vim.re = require('vim.re')
|
|
vim.secure = require('vim.secure')
|
|
vim.snippet = require('vim.snippet')
|
|
vim.text = require('vim.text')
|
|
vim.treesitter = require('vim.treesitter')
|
|
vim.tty = require('vim.tty')
|
|
vim.ui = require('vim.ui')
|
|
vim.version = require('vim.version')
|
|
|
|
local uri = require('vim.uri')
|
|
|
|
vim.uri_from_fname = uri.uri_from_fname
|
|
vim.uri_from_bufnr = uri.uri_from_bufnr
|
|
vim.uri_to_fname = uri.uri_to_fname
|
|
vim.uri_to_bufnr = uri.uri_to_bufnr
|
|
|
|
vim.provider = require('vim.provider')
|