package vcaml

You can search for identifiers within the package.

in-package search v0.2.0

vcaml
- Vcaml
  - Api_call
    
    Let_syntax
    
    Let_syntax
  - Buf
    
    Event
    
    Table
    
    Provide_bin_io
    
    Key
    
    Provide_of_sexp
    
    Key
    
    Untested
  - Channel_info
  - Client
    
    Connection_type
    
    Untested
  - Client_info
    
    Client_method
    
    Client_type
    
    Version
  - Defun
    
    Ocaml
    
    Async
    
    Sync
    
    Vim
  - Keymap
    
    Untested
  - Nvim_command
  - Property
  - Tabpage
    
    Untested
  - Type
  - Window
    
    Untested
vcaml.msgpack
- Msgpack
  - Custom
  - Internal
    
    Parser
    
    Serializer
  - Message
vcaml.msgpack_rpc
- Msgpack_rpc
  - Connection
  - Make
    
    M
  - S
vcaml.msgpack_unix
- Msgpack_unix
  - Unix_socket
vcaml.nvim_internal
- Nvim_internal
  - Types
    
    Buffer
    
    Nvim_ext
    
    Phantom
    
    Tabpage
    
    Window
  - Wrappers

Legend:
Library
Module
Module type
Parameter
Class
Class type

A Defun.Vim.t value is a reified value corresponding to the type of a function. It is used by wrap_viml_function to produce a regular ocaml function of the correct type.

type ('f, 'leftmost_input, 'out) t

val return : 'a Type.t -> ('a Core.Or_error.t api_call, unit, 'a) t

Wraps a Type.t to be used as the rightmost (return) type of this function.

val unary : 
  'a Type.t ->
  'b Type.t ->
  ('a -> 'b Core.Or_error.t api_call, 'a, 'b) t

val (@->) : 'a Type.t -> ('b, _, 'output) t -> ('a -> 'b, 'a, 'output) t

Add an extra argument to an existing function arity.

Using this operator, function types will look extremely closely to how the underlying OCaml type will end up. For example, a vim function with (OCaml) type int -> string -> int -> buffer would use the arity Integer @-> String @-> Integer @-> return Buffer.

Unfortunately, there is currently no nice way to automatically de/serialize more complex/custom types. In those cases, you may need to use Object or Dictionary, then wrap the output of wrap_viml_function to call your serialization or deserialization functions.