struct LSP::SymbolInformation

Overview

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

Included Modules

Defined in:

requests/language_features/document_symbols.cr

Constructors

Instance Method Summary

Macros inherited from module JSON::Serializable

json_discriminator(field, mapping, *, default = nil) json_discriminator

Constructor Detail

def self.new(pull : JSON::PullParser) #

[View source]
def self.new(**args) #

[View source]

Instance Method Detail

def container_name : String | Nil #

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.


[View source]
def container_name=(container_name : String | Nil) #

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.


[View source]
def deprecated : Bool | Nil #

Indicates if this symbol is deprecated.


[View source]
def deprecated=(deprecated : Bool | Nil) #

Indicates if this symbol is deprecated.


[View source]
def kind : LSP::SymbolKind #

The kind of this symbol.


[View source]
def kind=(kind : LSP::SymbolKind) #

The kind of this symbol.


[View source]
def location : LSP::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 then 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 a abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.


[View source]
def location=(location : LSP::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 then 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 a abstract syntax tree. It can therefore not be used to re-construct a hierarchy of the symbols.


[View source]
def name : String #

The name of this symbol.


[View source]
def name=(name : String) #

The name of this symbol.


[View source]