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/Message/index.html

Module Debug_protocol.MessageSource

Sourcemodule Variables : sig ... end
Sourcetype t = {
  1. id : int;
    (*

    Unique (within a debug adapter implementation) identifier for the message. The purpose of these error IDs is to help extension authors that have the requirement that every user visible error message needs a corresponding error number, so that users or customer support can find information about the specific error more easily.

    *)
  2. format : string;
    (*

    A format string for the message. Embedded variables have the form `{name}`. If variable name starts with an underscore character, the variable does not contain user data (PII) and can be safely used for telemetry purposes.

    *)
  3. variables : Variables.t option;
    (*

    An object used as a dictionary for looking up the variables in the format string.

    *)
  4. send_telemetry : bool option;
    (*

    If true send to telemetry.

    *)
  5. show_user : bool option;
    (*

    If true show user.

    *)
  6. url : string option;
    (*

    A url where additional information about this message can be found.

    *)
  7. url_label : string option;
    (*

    A label that is presented to the user as the UI for opening the url.

    *)
}

A structured message object. Used to return errors from requests.

Sourceval make : id:int -> format:string -> ?variables:Variables.t option -> ?send_telemetry:bool option -> ?show_user:bool option -> ?url:string option -> ?url_label:string option -> unit -> t
Sourceval to_yojson : t -> Yojson.Safe.t