class

LSProtocol::WorkspaceSymbolParams

Inherits JSON::Serializable / Reference / Object

The parameters of a WorkspaceSymbolRequest.

Constructors

new(pull : JSON::PullParser)
Source
new(query : String | Nil, partial_result_token : ProgressToken | Nil = nil, work_done_token : ProgressToken | Nil = nil)
Source
new(*, __pull_for_json_serializable pull : JSON::PullParser)
Source

Instance methods

partial_result_token

An optional token that a server can use to report partial results (e.g. streaming) to the client.

Source
query

A query string to filter symbols by. Clients may send an empty string here to request all symbols.

The query-parameter should be interpreted in a relaxed way as editors will apply their own highlighting and scoring on the results. A good rule of thumb is to match case-insensitive and to simply check that the characters of query appear in their order in a candidate symbol. Servers shouldn't use prefix, substring, or similar strict matching.

Source
work_done_token

An optional token that a server can use to report work done progress.

Source