class LanguageServer::Protocol::Interface::WorkspaceSymbolParams

The parameters of a Workspace Symbol Request.

Attributes

attributes[R]

Public Class Methods

new(work_done_token: nil, partial_result_token: nil, query:) click to toggle source
# File lib/language_server/protocol/interface/workspace_symbol_params.rb, line 8
def initialize(work_done_token: nil, partial_result_token: nil, query:)
  @attributes = {}

  @attributes[:workDoneToken] = work_done_token if work_done_token
  @attributes[:partialResultToken] = partial_result_token if partial_result_token
  @attributes[:query] = query

  @attributes.freeze
end

Public Instance Methods

partial_result_token() click to toggle source

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

@return [ProgressToken]

# File lib/language_server/protocol/interface/workspace_symbol_params.rb, line 31
def partial_result_token
  attributes.fetch(:partialResultToken)
end
query() click to toggle source

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

@return [string]

# File lib/language_server/protocol/interface/workspace_symbol_params.rb, line 40
def query
  attributes.fetch(:query)
end
to_hash() click to toggle source
# File lib/language_server/protocol/interface/workspace_symbol_params.rb, line 46
def to_hash
  attributes
end
to_json(*args) click to toggle source
# File lib/language_server/protocol/interface/workspace_symbol_params.rb, line 50
def to_json(*args)
  to_hash.to_json(*args)
end
work_done_token() click to toggle source

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

@return [ProgressToken]

# File lib/language_server/protocol/interface/workspace_symbol_params.rb, line 22
def work_done_token
  attributes.fetch(:workDoneToken)
end