class

LSProtocol::WorkspaceSymbol

Inherits JSON::Serializable / Reference / Object

A special workspace symbol that supports locations without a range.

See also SymbolInformation.

@since 3.17.0

Constructors

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)
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
data

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

Source
kind

The kind of this symbol.

Source
location

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.

Source
name

The name of this symbol.

Source
tags

Tags for this symbol.

@since 3.16.0

Source