Class: LanguageServer::Protocol::Interface::WorkspaceSymbolParams

Inherits:
Object
  • Object
show all
Defined in:
lib/language_server/protocol/interface/workspace_symbol_params.rb

Overview

The parameters of a Workspace Symbol Request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(work_done_token: nil, partial_result_token: nil, query:) ⇒ WorkspaceSymbolParams

Returns a new instance of WorkspaceSymbolParams.



8
9
10
11
12
13
14
15
16
 
# 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

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



44
45
46
 
# File 'lib/language_server/protocol/interface/workspace_symbol_params.rb', line 44

def attributes
  @attributes
end

Instance Method Details

#partial_result_token ⇒ ProgressToken

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

Returns:

  • (ProgressToken) 


31
32
33
 
# File 'lib/language_server/protocol/interface/workspace_symbol_params.rb', line 31

def partial_result_token
  attributes.fetch(:partialResultToken)
end

#query ⇒ string

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

Returns:

  • (string) 


40
41
42
 
# File 'lib/language_server/protocol/interface/workspace_symbol_params.rb', line 40

def query
  attributes.fetch(:query)
end

#to_hash ⇒ Object 



46
47
48
 
# File 'lib/language_server/protocol/interface/workspace_symbol_params.rb', line 46

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



50
51
52
 
# 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 ⇒ ProgressToken

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

Returns:

  • (ProgressToken) 


22
23
24
 
# File 'lib/language_server/protocol/interface/workspace_symbol_params.rb', line 22

def work_done_token
  attributes.fetch(:workDoneToken)
end