class

LSProtocol::SymbolInformation

Inherits JSON::Serializable / Reference / Object

Represents information about programming constructs like variables, classes, interfaces etc.

Constructors

new(kind : SymbolKind | Nil, location : Location | Nil, name : String | Nil, container_name : String | Nil = nil, deprecated : Bool | Nil = nil, tags : Array(SymbolTag) | Nil = nil)
Source
new(pull : JSON::PullParser)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

container_name

The name of the symbol containing this symbol. This information is for user interface purposes (e.g. to render a qualifier in the user interface if necessary). It can't be used to re-infer a hierarchy for the document symbols.

Source
deprecated

Indicates if this symbol is deprecated.

@deprecated Use tags instead

Source
kind

The kind of this symbol.

Source
location

The location of this symbol. The location's range is used by a tool to reveal the location in the editor. If the symbol is selected in the tool the range's start information is used to position the cursor. So the range usually spans more than the actual symbol's name and does normally include things like visibility modifiers.

The range doesn't have to denote a node range in the sense of an abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.

Source
name

The name of this symbol.

Source
tags

Tags for this symbol.

@since 3.16.0

Source