Struct Variable

pub struct Variable {
    pub name: String,
    pub value: String,
    pub typing: String,
    pub evaluate_name: String,
    pub variables_reference: usize,
    pub named_variables: usize,
    pub indexed_variables: usize,
    pub memory_reference: String,
}

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.

Fields

name: String

The variable’s name.

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.

typing: 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.

evaluate_name: String

The evaluate name of this variable which can be passed to the evaluate request to fetch the variable’s value.

variables_reference: usize

If variablesReference is > 0, the variable is structured and its children 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.

named_variables: usize

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.

indexed_variables: usize

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.

memory_reference: String

A memory reference to a location appropriate for this result. For pointer type eval results, this is generally a reference to the memory address contained in the pointer. This attribute may be returned by a debug adapter if corresponding capability supportsMemoryReferences is true.

Trait Implementations

impl Clone for Variable

fn clone(&self) -> Variable

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for Variable

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Serialize for Variable

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.