package dap

  1. Overview
  2. Docs
Debug adapter protocol

Install

dune-project
 Dependency

Authors

Maintainers

Sources

dap-1.1.0.tbz
sha256=0b4cdef2ec61b98f73b686a6cb9cde8dde14404097f52a9367c55f1667441712
sha512=ba1897e3afa66b34ad65911dee0b433c48756a5c81467b6277cc2fc1f4360533af7c707744b87707afa9891886dcdb0f7fa7e1653807903f5bd2c1d36a4d92d0

doc/dap.types/Debug_protocol/Response/index.html

Module Debug_protocol.ResponseSource

Sourcemodule Type : sig ... end
Sourcemodule Message : sig ... end
Sourcetype t = {
  1. seq : int;
    (*

    Sequence number of the message (also known as message ID). The `seq` for the first message sent by a client or debug adapter is 1, and for each subsequent message is 1 greater than the previous message sent by that actor. `seq` can be used to order requests, responses, and events, and to associate requests with their corresponding responses. For protocol messages of type `request` the sequence number can be used to cancel the request.

    *)
  2. type_ : Type.t;
  3. request_seq : int;
    (*

    Sequence number of the corresponding request.

    *)
  4. success : bool;
    (*

    Outcome of the request. If true, the request was successful and the `body` attribute may contain the result of the request. If the value is false, the attribute `message` contains the error in short form and the `body` may contain additional information (see `ErrorResponse.body.error`).

    *)
  5. command : string;
    (*

    The command requested.

    *)
  6. message : Message.t option;
    (*

    Contains the raw error in short form if `success` is false. This raw error might be interpreted by the client and is not shown in the UI. Some predefined values exist.

    *)
  7. body : Yojson.Safe.t;
    (*

    Contains request result if success is true and error details if success is false.

    *)
}
Sourceval make : seq:int -> type_:Type.t -> request_seq:int -> success:bool -> command:string -> ?message:Message.t option -> ?body:Yojson.Safe.t -> unit -> t
Sourceval to_yojson : t -> Yojson.Safe.t