nvim_utils/vim/
mod.rs

1//! # Semi-direct mapping of the `vim` module in Neovim's lua api
2//!
3//! The goal for this module is to provide an idiomatic way to call Neovim's lua api from Rust, without needing to repeat the boilerplate for loading specific functions.
4//!
5//! Notable differences from the lua api:
6//! - `vim.fn` has been renamed to `vim::func`, since fn is a keyword in Rust
7//! - Added `vim::ext` for functions that don't directly map to the Neovim api but make use of it or extend it
8//! - Not all functions are implemented yet
9
10pub mod api;
11pub mod ext;
12pub mod func;
13pub mod keymap;
14pub mod log;
15pub mod v;
16
17use crate::prelude::*;
18
19/// Get global `vim`
20///
21/// ## Example
22/// ```rust
23/// use nvim_utils::prelude::*;
24/// fn my_module(lua: &mlua::prelude::Lua) -> mlua::prelude::LuaResult<()> {
25///     let global_vim = vim::get(lua)?;
26///     let vim_version: LuaTable = global_vim.call_function("version", ())?;
27///     println!("Vim version: {}", vim::inspect(lua, vim_version)?);
28///     Ok(())
29/// }
30/// ```
31pub fn get(lua: &Lua) -> LuaResult<LuaTable> {
32    lua.globals().get("vim")
33}
34
35/// Corresponds to `vim.cmd()`
36///
37/// ## Example
38/// ```rust
39/// use nvim_utils::prelude::*;
40/// fn my_module(lua: &mlua::prelude::Lua) -> mlua::prelude::LuaResult<()> {
41///     vim::cmd(lua, "echo 'Hello, world!'")?;
42///     vim::cmd(lua, "terminal")
43/// }
44/// ```
45pub fn cmd(lua: &Lua, cmd: &str) -> LuaResult<()> {
46    self::get(lua)?.get::<_, LuaTable>("cmd")?.call(cmd)
47}
48
49/// Corresponds to `vim.inspect()`
50///
51/// ## Example
52/// ```rust
53/// use nvim_utils::prelude::*;
54/// fn my_module(lua: &Lua) -> LuaResult<()> {
55///     let table = lua.create_table()?;
56///     table.set("foo", "bar")?;
57///     let inspect = vim::inspect(lua, table)?;
58///     Ok(())
59/// }
60/// ```
61pub fn inspect<'a>(lua: &'a Lua, value: impl ToLua<'a>) -> LuaResult<String> {
62    self::get(lua)?.call_function("inspect", value)
63}
64
65/// Corresponds to `vim.notify()`
66///
67/// ## Example
68/// ```rust
69/// use nvim_utils::prelude::*;
70/// fn my_module(lua: &mlua::prelude::Lua) -> mlua::prelude::LuaResult<()> {
71///     vim::notify(lua, "Loaded module!", vim::log::LogLevel::Info)
72/// }
73/// ```
74pub fn notify(lua: &Lua, msg: &str, log_level: log::LogLevel) -> LuaResult<()> {
75    self::get(lua)?.call_function("notify", (msg, log_level as u8))
76}
nvim_utils/vim/mod.rs

nvim_utils/vim/
mod.rs
