Class: LanguageServer::Protocol::Interface::CodeActionParams

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

Overview

Params for the CodeActionRequest

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(work_done_token: nil, partial_result_token: nil, text_document:, range:, context:) ⇒ CodeActionParams

Returns a new instance of CodeActionParams.



8
9
10
11
12
13
14
15
16
17
18
 
# File 'lib/language_server/protocol/interface/code_action_params.rb', line 8

def initialize(work_done_token: nil, partial_result_token: nil, text_document:, range:, context:)
  @attributes = {}

  @attributes[:workDoneToken] = work_done_token if work_done_token
  @attributes[:partialResultToken] = partial_result_token if partial_result_token
  @attributes[:textDocument] = text_document
  @attributes[:range] = range
  @attributes[:context] = context

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



61
62
63
 
# File 'lib/language_server/protocol/interface/code_action_params.rb', line 61

def attributes
  @attributes
end

Instance Method Details

#context ⇒ CodeActionContext

Context carrying additional information.

Returns:



57
58
59
 
# File 'lib/language_server/protocol/interface/code_action_params.rb', line 57

def context
  attributes.fetch(:context)
end

#partial_result_token ⇒ ProgressToken

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

Returns:

  • (ProgressToken) 


33
34
35
 
# File 'lib/language_server/protocol/interface/code_action_params.rb', line 33

def partial_result_token
  attributes.fetch(:partialResultToken)
end

#range ⇒ Range

The range for which the command was invoked.

Returns:



49
50
51
 
# File 'lib/language_server/protocol/interface/code_action_params.rb', line 49

def range
  attributes.fetch(:range)
end

#text_document ⇒ TextDocumentIdentifier

The document in which the command was invoked.

Returns:



41
42
43
 
# File 'lib/language_server/protocol/interface/code_action_params.rb', line 41

def text_document
  attributes.fetch(:textDocument)
end

#to_hash ⇒ Object 



63
64
65
 
# File 'lib/language_server/protocol/interface/code_action_params.rb', line 63

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



67
68
69
 
# File 'lib/language_server/protocol/interface/code_action_params.rb', line 67

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) 


24
25
26
 
# File 'lib/language_server/protocol/interface/code_action_params.rb', line 24

def work_done_token
  attributes.fetch(:workDoneToken)
end