class LSProtocol::WorkspaceSymbol

Overview

A special workspace symbol that supports locations without a range.

See also SymbolInformation.

@since 3.17.0

Included Modules

Defined in:

lsprotocol/types.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(kind : SymbolKind | Nil, location : Location | LocationUriOnly | Nil, name : String | Nil, container_name : String | Nil = nil, data : LSPAny | Nil = nil, tags : Array(SymbolTag) | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[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 data : LSPAny | Nil #

A data entry field that is preserved on a workspace symbol between a workspace symbol request and a workspace symbol resolve request.


[View source]
def kind : SymbolKind #

The kind of this symbol.


[View source]
def location : Location | LocationUriOnly #

The location of the symbol. Whether a server is allowed to return a location without a range depends on the client capability workspace.symbol.resolveSupport.

See SymbolInformation#location for more details.


[View source]
def name : String #

The name of this symbol.


[View source]
def tags : Array(SymbolTag) | Nil #

Tags for this symbol.

@since 3.16.0


[View source]