Crate nvim_oxi

Source
Expand description

§Rust bindings to all things Neovim

This library provides safe bindings to the API exposed by the Neovim text editor.

Modules§

api
Bindings to the Neovim C API.
conversion
Traits for converting between Neovim Objects and Rust types.
iter
Iterators over Arrays and Dictionarys.
libuvlibuv
Bindings to the Neovim event loop powered by libuv.
lua
Low-level Rust bindings to LuaJIT, the Lua version used by Neovim.
mluamlua
Integrations with the mlua Rust crate providing safe Lua bindings.
serde
(De)Serialization support for Neovim Objects using Serde.
tests

Macros§

dbg
Same as std::dbg! but writes to the Neovim message area instead of stdout.
print
Same as std::print! but writes to the Neovim message area instead of stdout.
string
Same as format! but creates an nvim_oxi::String.

Structs§

Arena
A memory arena that is passed to the C API for allocation.
Array
A vector of Neovim Objects.
Dictionary
A vector of Neovim (String, Object) pairs.
Function
A wrapper around a Lua reference to a function stored in the Lua registry.
KeyValuePair
A key-value pair mapping a String to an Object.
NonOwning
A non-owning value for lifetime 'a.
NvimStr
A borrowed version of NvimString.
Object
Binding to a Neovim object.
String
Binding to the string type used by Neovim.
StringBuilder
A builder that can be used to efficiently build nvim_oxi::Strings.

Enums§

ArrayFromTupleError
The error type returned when trying to convert an Array into a tuple.
Error
nvim-oxi’s error type.
ObjectKind
Specifies the kind of a Neovim Object.

Traits§

IntoResult
A trait for types that can be converted into a Result.

Functions§

schedule
Binding to vim.schedule().

Type Aliases§

Result
nvim-oxi’s result type.

Attribute Macros§

plugin
Marks a function as the entrypoint of the plugin.
testtest
Tests a piece of code from inside Neovim.