[−][src]Crate nvim_rs
Rust library for Neovim clients
Implements support for rust plugins for Neovim through its msgpack-rpc API.
Origins
This library started as a fork of
neovim-lib with the goal to utilize
Rust's async/await to allow requests/notification to/from neovim to be
arbitrarily nested. After the fork, I started implementing more ideas I had
for this library.
Status
As of the end of 2019, I'm somewhat confident to recommend starting to use
this library. The overall handling should not change anymore. A breaking
change I kind of expect is adding error variants to
CallError when I start working on the API
(right now, it panics when messages don't have the right format, I'll want
to return proper errors in that case).
I've not yet worked through the details of what-to-export, but I'm quite willing to consider what people need or want.
Re-exports
pub use crate::neovim::Neovim; |
pub use crate::rpc::handler::Handler; |
pub use crate::uioptions::UiAttachOptions; |
pub use crate::uioptions::UiOption; |
Modules
| compat | This module contains compatibility wrappers and other adapter thingies to bridge between various async libraries. |
| create | Functions to spawn a |
| error | Errors of nvim-rs. |
| examples | Examples on how to use |
| exttypes | Buffers, windows, tabpages of neovim |
| neovim | An active neovim session. |
| neovim_api | The auto generated API for |
| neovim_api_manual | Some manually implemented API functions |
| rpc | RPC functionality for |
| uioptions | Options for UI implementations |
Macros
| call_args | Pack the given arguments into a |
Structs
| Buffer | A struct representing a neovim buffer. It is specific to a
|
| Tabpage | A struct representing a neovim tabpage. It is specific to a
|
| Window | A struct representing a neovim window. It is specific to a
|
Enums
| Value | Represents any valid MessagePack value. |