Variable class
A Variable is a name/value pair.
The type
attribute is shown if space permits or when hovering over the
variable's name.
The kind
attribute 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 variables
request.
If the number of named or indexed children is large, the numbers should be
returned via the namedVariables
and indexedVariables
attributes.
The client can use this information to present the children in a paged UI
and fetch them in chunks.
Constructors
Properties
- evaluateName → String?
-
The evaluatable name of this variable which can be passed to the
evaluate
request to fetch the variable's value.final - hashCode → int
-
The hash code for this object.
no setterinherited
- indexedVariables → int?
-
The number of indexed child variables.
The client can use this information to present the children in a paged UI
and fetch them in chunks.
final
- memoryReference → String?
-
The memory reference for the variable if the variable represents
executable code, such as a function pointer.
This attribute is only required if the corresponding capability
supportsMemoryReferences
is true.final - name → String
-
The variable's name.
final
- namedVariables → int?
-
The number of named child variables.
The client can use this information to present the children in a paged UI
and fetch them in chunks.
final
- presentationHint → VariablePresentationHint?
-
Properties of a variable that can be used to determine how to render the
variable in the UI.
final
- runtimeType → Type
-
A representation of the runtime type of the object.
no setterinherited
- type → String?
-
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
corresponding capability
supportsVariableType
is true.final - value → String
-
The variable's value.
This can be a multi-line text, e.g. for a function the body of a function.
For structured variables (which do not have a simple value), it is
recommended to provide a one-line representation of the structured object.
This helps to identify the structured object in the collapsed state when
its children are not yet visible.
An empty string can be used if no value should be shown in the UI.
final
- variablesReference → int
-
If
variablesReference
is > 0, the variable is structured and its children can be retrieved by passingvariablesReference
to thevariables
request as long as execution remains suspended. See 'Lifetime of Object References' in the Overview section for details.final
Methods
-
noSuchMethod(
Invocation invocation) → dynamic -
Invoked when a nonexistent method or property is accessed.
inherited
-
toJson(
) → Map< String, Object?> -
toString(
) → String -
A string representation of this object.
inherited
Operators
-
operator ==(
Object other) → bool -
The equality operator.
inherited