package dap

  1. Overview
  2. Docs

Module Output_event.PayloadSource

Sourcemodule Category : sig ... end
Sourcemodule Group : sig ... end
Sourcetype t = {
  1. category : Category.t option;
    (*

    The output category. If not specified or if the category is not understood by the client, `console` is assumed.

    *)
  2. output : string;
    (*

    The output to report.

    ANSI escape sequences may be used to influence text color and styling if `supportsANSIStyling` is present in both the adapter's `Capabilities` and the client's `InitializeRequestArguments`. A client may strip any unrecognized ANSI sequences.

    If the `supportsANSIStyling` capabilities are not both true, then the client should display the output literally.

    *)
  3. group : Group.t option;
    (*

    Support for keeping an output log organized by grouping related messages.

    *)
  4. variables_reference : int option;
    (*

    If an attribute `variablesReference` exists and its value is > 0, the output contains objects which can be retrieved by passing `variablesReference` to the `variables` request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details.

    *)
  5. source : Source.t option;
    (*

    The source location where the output was produced.

    *)
  6. line : int option;
    (*

    The source location's line where the output was produced.

    *)
  7. column : int option;
    (*

    The position in `line` where the output was produced. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based.

    *)
  8. data : Any.t option;
    (*

    Additional data to report. For the `telemetry` category the data is sent to telemetry, for the other categories the data is shown in JSON format.

    *)
  9. location_reference : int option;
    (*

    A reference that allows the client to request the location where the new value is declared. For example, if the logged value is function pointer, the adapter may be able to look up the function's location. This should be present only if the adapter is likely to be able to resolve the location.

    This reference shares the same lifetime as the `variablesReference`. See 'Lifetime of Object References' in the Overview section for details.

    *)
}
Sourceval make : ?category:Category.t option -> output:string -> ?group:Group.t option -> ?variables_reference:int option -> ?source:Source.t option -> ?line:int option -> ?column:int option -> ?data:Any.t option -> ?location_reference:int option -> unit -> t
Sourceval to_yojson : t -> Yojson.Safe.t