package dap

  1. Overview
  2. Docs
Debug adapter protocol

Install

Dune Dependency

Authors

Maintainers

Sources

dap-1.0.2.tbz
sha256=5e14788efb74983486d34a0376669543837e4df32e9a267a5472a9c94b7b743f
sha512=1e075d34cbd290fda63bed2deade9972decc05553c68682b9e82891819129e1070e39f8f12f37deaa7a586fc259cc603d586effe227db123eacb94eced770a97

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

Module Debug_protocol.VariableSource

Sourcetype t = {
  1. name : string;
    (*

    The variable's name.

    *)
  2. value : string;
    (*

    The variable's value. This can be a multi-line text, e.g. for a function the body of a function.

    *)
  3. type_ : string option;
    (*

    The type of the variable's value. Typically shown in the UI when hovering over the value. This attribute should only be returned by a debug adapter if the client has passed the value true for the 'supportsVariableType' capability of the 'initialize' request.

    *)
  4. presentation_hint : Variable_presentation_hint.t option;
    (*

    Properties of a variable that can be used to determine how to render the variable in the UI.

    *)
  5. evaluate_name : string option;
    (*

    Optional evaluatable name of this variable which can be passed to the 'EvaluateRequest' to fetch the variable's value.

    *)
  6. variables_reference : int;
    (*

    If variablesReference is > 0, the variable is structured and its children can be retrieved by passing variablesReference to the VariablesRequest.

    *)
  7. named_variables : int option;
    (*

    The number of named child variables. The client can use this optional information to present the children in a paged UI and fetch them in chunks.

    *)
  8. indexed_variables : int option;
    (*

    The number of indexed child variables. The client can use this optional information to present the children in a paged UI and fetch them in chunks.

    *)
  9. memory_reference : string option;
    (*

    Optional memory reference for the variable if the variable represents executable code, such as a function pointer. This attribute is only required if the client has passed the value true for the 'supportsMemoryReferences' capability of the 'initialize' request.

    *)
}

A Variable is a name/value pair. Optionally a variable can have a 'type' that is shown if space permits or when hovering over the variable's name. An optional 'kind' is used to render additional properties of the variable, e.g. different icons can be used to indicate that a variable is public or private. If the value is structured (has children), a handle is provided to retrieve the children with the VariablesRequest. If the number of named or indexed children is large, the numbers should be returned via the optional 'namedVariables' and 'indexedVariables' attributes. The client can use this optional information to present the children in a paged UI and fetch them in chunks.

Sourceval make : name:string -> value:string -> ?type_:string option -> ?presentation_hint:Variable_presentation_hint.t option -> ?evaluate_name:string option -> variables_reference:int -> ?named_variables:int option -> ?indexed_variables:int option -> ?memory_reference:string option -> unit -> t
Sourceval to_yojson : t -> Yojson.Safe.t
OCaml

Innovation. Community. Security.