package ocamlformat-rpc-lib

You can search for identifiers within the package.

in-package search v0.2.0

ocamlformat-rpc-lib
- CHANGES
- README
- Library ocamlformat-rpc-lib
  - Ocamlformat_rpc_lib
    
    Protocol
    
    Version
    
    Make
    
    Command_S
    
    Init
    
    V1
    
    V2
    
    Version
    
    IO
    
    Make
    
    V1
    
    Client
    
    V2
    
    Client
- Sources
  - ocamlformat-rpc-lib
    
    IO.ml
    
    ocamlformat_rpc_lib.ml
    
    ocamlformat_rpc_lib__.ml
    
    protocol.ml

Legend:
Page
Library
Module
Module type
Parameter
Class
Class type
Source

Module `Ocamlformat_rpc_lib`Source

OCamlformat RPC API.

This module defines the commands exchanged between the server and the client, and the way to build RPC clients.

The whole API is functorized over an IO module defining the blocking interface for reading and writing the data.

After you decided on the IO implementation, the Ocamlformat_rpc_lib.Make API can then be instantiated:

  module RPC = Ocamlformat_rpc_lib.Make (IO)

Sourcemodule Protocol : sig ... end

Sourcetype format_args = Protocol.format_args

Sourceval empty_args : format_args

Sourcemodule Version = Protocol.Version

Sourcemodule type IO = sig ... end

Defines the blocking interface for reading and writing to Cohttp streams

Sourcemodule Make (IO : IO) : sig ... end

For a basic working example, see: test/rpc/rpc_test.ml.

Disclaimer:

The ocamlformat-rpc-lib API is versioned to offer some basic backwards compatibility. Note that this guarantee is "best effort", meaning the authors will try to minimize the changes over time and preserve the original behavior or versioned clients as much as possible. However structural changes may happen.

package ocamlformat-rpc-lib

Module Ocamlformat_rpc_libSource

Module `Ocamlformat_rpc_lib`Source