Module Vcaml_debug.Toplevel_client

type t

This is a barebones implementation of Msgpack RPC for Neovim to facilitate debugging problems in the VCaml library by seeing if the problem is in VCaml or Neovim.

val open_ : string -> t

Open a connection to a running Neovim instance. You can find the name by checking v:servername or $NVIM.

val channel : t -> int

Get the channel for this connection. Once you have this you can issue rpcrequest and rpcnotify calls from your running Neovim instance to OCaml.

val request : t -> string -> Msgpack.t list -> unit

Send a synchronous request.

val notify : t -> string -> Msgpack.t list -> unit

Send an asynchronous notification.

val respond : t -> msgid:int -> (Msgpack.t, Msgpack.t) Core.Result.t -> unit

Respond to an rpcrequest. The msgid must be the same as the one Neovim sent.

val receive : t -> [ `Connection_closed | `Waiting_for_neovim | `Message of Msgpack.t ]

Receive a message from Neovim.

val receive_all_available : t -> Msgpack.t list

Read all available messages from Neovim. Useful for cases where you expect many messages, e.g., for event subscriptions.

val close : t -> unit

Close the connection.

val verbose : t -> bool -> unit

Enable / disable printing messages as they are sent and received.

val pp : Core.Formatter.t -> Msgpack.t -> unit