package dap

  1. Overview
  2. Docs
package dap
Legend:
Library
Module
Module type
Parameter
Class
Class type
module Type : sig ... end
module Message : sig ... end
type t = {
  1. seq : int;
    (*

    Sequence number (also known as message ID). For protocol messages of type 'request' this ID 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 frontend and is not shown in the UI. Some predefined values exist.

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

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

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