package vcaml

You can search for identifiers within the package.

in-package search v0.2.0

OCaml bindings for the Neovim API

Install

Dune Dependency

github.com Readme Changelog MIT License Edit opam file Versions (4)

Authors

J

Jane Street Group, LLC

Maintainers

J

Jane Street developers

Sources

vcaml-v0.16.0.tar.gz

sha256=dd123302c46af7ca6eda8a7806c78236fd217a8c73a2e1cd7da85f1d69ed1ae4

doc/vcaml.plugin/Vcaml_plugin/Persistent/Make/argument-1-P/index.html

Parameter `Make.P`

type state

val sexp_of_state : state -> Sexplib0.Sexp.t

val name : string

val description : string

Used as the summary argument for command.

val on_error : [ `Raise | `Call of Vcaml.Vcaml_error.t -> unit ]

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.

val rpc_handlers : state Vcaml_plugin__.Vcaml_plugin_intf.Persistent.Rpc.t list

val init_state : unit -> state

val on_startup : 
  [ `connected ] Vcaml.Client.t ->
  state ->
  shutdown:(unit -> unit) ->
  unit Async.Deferred.Or_error.t

val vimscript_notify_fn : string option

If specified, this Vimscript function will be called after on_startup finishes. It should be used as the indication to Neovim that the plugin is now ready to start serving RPCs - before this it's possible to be in a bad state (the RPCs may not yet be registered or on_startup may not have finished running). It should take a single integer argument, which will be the channel ID.

val on_shutdown : 
  [ `connected ] Vcaml.Client.t ->
  state ->
  unit Async.Deferred.Or_error.t