package dune-rpc

You can search for identifiers within the package.

in-package search v0.2.0

package dune-rpc

dune-rpc
- Dune_rpc
  - V1
    
    Client
    
    Make
    
    Batch
    
    Chan
    
    Fiber
    
    Ivar
    
    O
    
    Handler
    
    Stream
    
    Versioned
    
    S
    
    Batch
    
    Handler
    
    Stream
    
    Versioned
    
    Diagnostic
    
    Event
    
    Id
    
    Promotion
    
    Related
    
    Id
    
    Initialize
    
    Loc
    
    Message
    
    Notification
    
    Path
    
    Progress
    
    Registry
    
    Config
    
    Dune
    
    Poll
    
    Fiber
    
    O
    
    _
    
    Refresh
    
    Request
    
    Response
    
    Error
    
    Sub
    
    Target
    
    Version_error
    
    Where
    
    Make
    
    Fiber
    
    O
    
    _
    
    S
dune-rpc.private
- Dune_rpc_private
  - Call
  - Client
    
    Make
    
    Batch
    
    Chan
    
    Fiber
    
    Ivar
    
    O
    
    Handler
    
    Stream
    
    Versioned
    
    S
    
    Batch
    
    Handler
    
    Stream
    
    Versioned
  - Conv
  - Decl
    
    Notification
    
    Request
  - Diagnostic
    
    Event
    
    Id
    
    Promotion
    
    Related
  - Fiber
    
    Ivar
    
    O
  - Id
    
    Map
    
    Multi
    
    Set
  - Initialize
    
    Request
    
    Response
  - Loc
  - Menu
  - Message
  - Packet
    
    Query
    
    Reply
  - Path
  - Procedures
    
    Poll
    
    Name
    
    Public
    
    Server_side
  - Progress
  - Protocol
  - Public
    
    Notification
    
    Request
    
    Sub
  - Registry
    
    Config
    
    Dune
    
    File
    
    Poll
    
    Fiber
    
    O
    
    _
    
    Refresh
  - Request
  - Response
    
    Error
  - Server_notifications
  - Sub
    
    Id
  - Target
  - Version
  - Version_error
  - Version_negotiation
    
    Request
    
    Response
  - Versioned
    
    Make
    
    Builder
    
    Fiber
    
    Ivar
    
    O
    
    Handler
    
    Staged
  - Where
    
    Make
    
    Fiber
    
    O
    
    _
    
    S

Legend:
Library
Module
Module type
Parameter
Class
Class type

The registry is where all running instances of dune rpc are stored.

It's used by clients to determine which dune rpc instance corresponds to the workspace they're trying to edit.

module Dune : sig ... end

a registered instance of dune. supposedly running and listening to rpc connections

module Config : sig ... end

The registy directory is located using xdg

type t

val create : Config.t -> t

val current : t -> Dune.t list

currently detected running instances

module Refresh : sig ... end

the result of polling the registry

module Poll (Fiber : sig ... end) (_ : sig ... end) : sig ... end

we can poll the registry efficiently using the following functor