class LSProtocol::WorkspaceSymbolParams
- LSProtocol::WorkspaceSymbolParams
- Reference
- Object
Overview
The parameters of a WorkspaceSymbolRequest.
Included Modules
- JSON::Serializable
Defined in:
lsprotocol/types.crConstructors
- .new(pull : JSON::PullParser)
- .new(query : String | Nil, partial_result_token : ProgressToken | Nil = nil, work_done_token : ProgressToken | Nil = nil)
Instance Method Summary
-
#partial_result_token : ProgressToken | Nil
An optional token that a server can use to report partial results (e.g.
-
#query : String
A query string to filter symbols by.
-
#work_done_token : ProgressToken | Nil
An optional token that a server can use to report work done progress.
Constructor Detail
Instance Method Detail
An optional token that a server can use to report partial results (e.g. streaming) to the client.
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.
An optional token that a server can use to report work done progress.