struct LSP::DocumentSymbol

LSP::DocumentSymbol
Struct
Value
Object

Overview

Represents programming constructs like variables, classes, interfaces etc. that appear in a document. Document symbols can be hierarchical and they have two ranges: one that encloses its definition and one that points to its most interesting range, e.g. the range of an identifier.

Included Modules

Defined in:

requests/language_features/document_symbols.cr

Instance Method Summary

#children : Array(DocumentSymbol)?
Children of this symbol, e.g.
#children=(children : Array(DocumentSymbol)?)
Children of this symbol, e.g.
#deprecated : Bool?
Indicates if this symbol is deprecated.
#deprecated=(deprecated : Bool?)
Indicates if this symbol is deprecated.
#detail : String?
More detail for this symbol, e.g the signature of a function.
#detail=(detail : String?)
More detail for this symbol, e.g the signature of a function.
#kind : LSP::SymbolKind
The kind of this symbol.
#kind=(kind : LSP::SymbolKind)
The kind of this symbol.
#name : String
The name of this symbol.
#name=(name : String)
The name of this symbol.
#range : LSP::Range
The range enclosing this symbol not including leading/trailing whitespace but everything else like comments.
#range=(range : LSP::Range)
The range enclosing this symbol not including leading/trailing whitespace but everything else like comments.
#selection_range : LSP::Range
#selection_range=(selection_range : LSP::Range)
#to_symbol_information_array(uri : String)

Constructor Detail

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

def self.new(**args) #

Instance Method Detail

def children : Array(DocumentSymbol)? #

Children of this symbol, e.g. properties of a class.

def children=(children : Array(DocumentSymbol)?) #

Children of this symbol, e.g. properties of a class.

def deprecated : Bool? #

Indicates if this symbol is deprecated.

def deprecated=(deprecated : Bool?) #

Indicates if this symbol is deprecated.

def detail : String? #

More detail for this symbol, e.g the signature of a function.

def detail=(detail : String?) #

More detail for this symbol, e.g the signature of a function.

def kind : LSP::SymbolKind #

The kind of this symbol.

def kind=(kind : LSP::SymbolKind) #

The kind of this symbol.

def name : String #

The name of this symbol. Will be displayed in the user interface and therefore must not be an empty string or a string only consisting of white spaces.

def name=(name : String) #

The name of this symbol. Will be displayed in the user interface and therefore must not be an empty string or a string only consisting of white spaces.

def range : LSP::Range #

The range enclosing this symbol not including leading/trailing whitespace but everything else like comments. This information is typically used to determine if the clients cursor is inside the symbol to reveal in the symbol in the UI.

def range=(range : LSP::Range) #

def selection_range : LSP::Range #

def selection_range=(selection_range : LSP::Range) #

def to_symbol_information_array(uri : String) #

lsp