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

Module Debug_protocol.BreakpointSource

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

    The identifier for the breakpoint. It is needed if breakpoint events are used to update or remove breakpoints.

    *)
  2. verified : bool;
    (*

    If true, the breakpoint could be set (but not necessarily at the desired location).

    *)
  3. message : string option;
    (*

    A message about the state of the breakpoint. This is shown to the user and can be used to explain why a breakpoint could not be verified.

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

    The source where the breakpoint is located.

    *)
  5. line : int option;
    (*

    The start line of the actual range covered by the breakpoint.

    *)
  6. column : int option;
    (*

    Start position of the source range covered by the breakpoint. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based.

    *)
  7. end_line : int option;
    (*

    The end line of the actual range covered by the breakpoint.

    *)
  8. end_column : int option;
    (*

    End position of the source range covered by the breakpoint. It is measured in UTF-16 code units and the client capability `columnsStartAt1` determines whether it is 0- or 1-based. If no end line is given, then the end column is assumed to be in the start line.

    *)
  9. instruction_reference : string option;
    (*

    A memory reference to where the breakpoint is set.

    *)
  10. offset : int option;
    (*

    The offset from the instruction reference. This can be negative.

    *)
  11. reason : Reason.t option;
    (*

    A machine-readable explanation of why a breakpoint may not be verified. If a breakpoint is verified or a specific reason is not known, the adapter should omit this property. Possible values include:

    • `pending`: Indicates a breakpoint might be verified in the future, but the adapter cannot verify it in the current state.
    • `failed`: Indicates a breakpoint was not able to be verified, and the adapter does not believe it can be verified without intervention.
    *)
}

Information about a breakpoint created in `setBreakpoints`, `setFunctionBreakpoints`, `setInstructionBreakpoints`, or `setDataBreakpoints` requests.

Sourceval make : ?id:int option -> verified:bool -> ?message:string option -> ?source:Source.t option -> ?line:int option -> ?column:int option -> ?end_line:int option -> ?end_column:int option -> ?instruction_reference:string option -> ?offset:int option -> ?reason:Reason.t option -> unit -> t
Sourceval to_yojson : t -> Yojson.Safe.t