package dune-rpc

  1. Overview
  2. Docs
Communicate with dune using rpc

Install 

dune-project
 Dependency

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

Authors

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Maintainers

  1. J
    Jane Street Group, LLC <opensource@janestreet.com>

Sources

dune-3.22.2.tbz
sha256=c2ccf8bc6b17afa47c450297357496303aa7c8680e329b79d98c68e35013a118
sha512=26d3df56a509c6e8937a9333944303bdd8800a41e1b869c3adfb76d1e1fe615b6ec41491d596bd5982e338dcf70b97c18f963f37bfbf2bd581cbd356f3d5f4e5

doc/dune-rpc.private/Dune_rpc_private/Client/Make/index.html

Module Client.MakeSource

Parameters

module Fiber : sig ... end
module Chan : sig ... end

Signature

Sourcemodule V : sig ... end
Sourcemodule Chan : sig ... end
Sourcetype t = {
  1. chan : Chan.t;
  2. requests : (Dune_rpc_private__.Types.Id.t, [ `Cancelled | `Pending of [ `Completed of (Stdune.Sexp.t, Dune_rpc_private__.Types.Response.Error.t) result | `Connection_dead | `Cancelled ] Fiber.Ivar.t ]) Stdune.Table.t;
  3. initialize : Dune_rpc_private__.Types.Initialize.Request.t;
  4. mutable next_id : int;
  5. mutable running : bool;
  6. mutable handler_initialized : bool;
  7. handler : unit V.Handler.t Fiber.t;
  8. on_preemptive_abort : Dune_rpc_private__.Exported_types.Message.t -> unit Fiber.t;
}
Sourceval terminate : t -> unit Fiber.t
Sourceval terminate_with_error : t -> string -> (string * Dyn.t) list -> 'a Fiber.t
Sourceval create : chan:Chan.t -> initialize:Dune_rpc_private__.Types.Initialize.Request.t -> handler:unit V.Handler.t Fiber.t -> on_preemptive_abort: (Dune_rpc_private__.Exported_types.Message.t -> unit Fiber.t) -> t
Sourceval prepare_request' : t -> (Dune_rpc_private__.Types.Id.t * Dune_rpc_private__.Types.Call.t) -> ([ `Cancelled | `Completed of (Stdune.Sexp.t, Dune_rpc_private__.Types.Response.Error.t) result | `Connection_dead ] Fiber.Ivar.t, Dune_rpc_private__.Types.Response.Error.t) result
Sourceval request_untyped : t -> (Dune_rpc_private__.Types.Id.t * Dune_rpc_private__.Types.Call.t) -> [ `Cancelled | `Completed of (Stdune.Sexp.t, Dune_rpc_private__.Types.Response.Error.t) result | `Connection_dead ] Fiber.t
Sourceval parse_response : t -> ('a -> ('b, Dune_rpc_private__.Types.Response.Error.t) result) -> ('a, 'c) result -> ('b, 'c) result Fiber.t
Sourceval gen_id : t -> Dune_rpc_private__.Types.Id.t option -> Dune_rpc_private__.Types.Id.t
Sourcemodule Versioned : sig ... end
Sourceval cancel : t -> Dune_rpc_private__.Types.Id.t -> unit Fiber.t
Sourceval make_notification : t -> 'a Versioned.notification -> 'a -> (Dune_rpc_private__.Types.Call.t -> 'a0) -> 'a0
Sourceval notification : t -> 'a Versioned.notification -> 'a -> unit Fiber.t
Sourceval disconnected : t -> unit Fiber.t
Sourcemodule Stream : sig ... end
Sourceval no_cancel_raise_connection_dead : Dune_rpc_private__.Types.Id.t -> [< `Cancelled | `Completed of ('a, Dune_rpc_private__.Types.Response.Error.t) result | `Connection_dead ] -> ('a, Dune_rpc_private__.Types.Response.Error.t) result
Sourceval request : ?id:??? -> t -> ('a, 'b) Versioned.request -> 'a -> ('b, Dune_rpc_private__.Types.Response.Error.t) result Fiber.t
Sourceval poll : ?id:??? -> t -> 'a Sub.t -> ('a Stream.t, Version_error.t) result Fiber.t
Sourcemodule Batch : sig ... end
Sourceval read_packets : t -> (unit -> Dune_rpc_private__.Types.Packet.t option Fiber.t) -> unit Fiber.t
Sourcemodule Handler : sig ... end
Sourcetype proc =
  1. | Request : ('a, 'b) Dune_rpc_private__.Types.Decl.Request.t -> proc
  2. | Notification : 'a Dune_rpc_private__.Types.Decl.Notification.t -> proc
  3. | Poll : 'a Procedures.Poll.t -> proc
  4. | Handle_request : ('a, 'b) Dune_rpc_private__.Types.Decl.Request.t * ('a -> 'b Fiber.t) -> proc
Sourceval setup_versioning : private_menu:proc list -> handler:Handler.t -> unit Dune_rpc_private__Versioned.Make(Fiber).Builder.t
Sourceval connect_raw : Chan.t -> Dune_rpc_private__.Types.Initialize.Request.t -> private_menu:proc list -> handler:Handler.t -> f:(t -> 'a Fiber.t) -> 'a Fiber.t
Sourceval connect_with_menu : ?handler:??? -> private_menu:proc list -> Chan.t -> Dune_rpc_private__.Types.Initialize.Request.t -> f:(t -> 'a Fiber.t) -> 'a Fiber.t
Sourceval connect : ?handler:??? -> Chan.t -> Dune_rpc_private__.Types.Initialize.Request.t -> f:(t -> 'a Fiber.t) -> 'a Fiber.t