package vcaml

  1. Overview
  2. Docs
package vcaml
Legend:
Library
Module
Module type
Parameter
Class
Class type
type 'state t
val create : on_error:[ `Raise | `Call of Vcaml_error.t -> unit ] -> [ `not_connected ] t

on_error is invoked when VCaml fails to parse a response from Neovim and when Neovim sends us an asynchronous error event to inform us that it encountered a problem with a message we sent.

module Connection_type : sig ... end

A value of type Connection_type.t describes the type of connection to use, along with the information necessary to connect to Neovim.

val attach : ?close_reader_and_writer_on_disconnect:bool -> [ `not_connected ] t -> 'a Connection_type.t -> time_source:Async.Time_source.t -> 'a Async.Deferred.Or_error.t

Attach to Neovim over an RPC channel. Once attach is called Neovim can start sending RPC requests and notifications, so handlers should be registered in advance with register_request_async and register_request_blocking as needed. Registering more handlers after attaching is allowed. Calling attach twice will raise.

val close : [ `connected ] t -> unit Async.Deferred.t

Close the client and release the underlying file descriptors. Can be called safely multiple times.

val channel : [ `connected ] t -> int

Returns Neovim's id for the channel over which Neovim and the client communicate. This can be useful when you want to set an autocmd or key mapping that issues an rcprequest or rpcnotify when triggered, since these functions requre the channel id as an argument.

OCaml

Innovation. Community. Security.

GitHub Discord Twitter Peertube RSS
About
Changelog Releases Industrial Users Academic Users Why OCaml
Ecosystem
Packages Community Events OCaml Planet Jobs
Resources
Install OCaml Get Started Platform Tools Language Manual Standard Library API Books Exercises Papers OCaml Playground Logo
Policies
Carbon Footprint Governance Privacy Code of Conduct