Class: LanguageServer::Protocol::Interface::DocumentHighlightParams

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

Overview

Parameters for a [DocumentHighlightRequest](#DocumentHighlightRequest).

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(text_document:, position:, work_done_token: nil, partial_result_token: nil) ⇒ DocumentHighlightParams

Returns a new instance of DocumentHighlightParams.



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

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

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

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



52
53
54
 
# File 'lib/language_server/protocol/interface/document_highlight_params.rb', line 52

def attributes
  @attributes
end

Instance Method Details

#partial_result_token ⇒ ProgressToken | nil

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

Returns:

  • (ProgressToken | nil) 


48
49
50
 
# File 'lib/language_server/protocol/interface/document_highlight_params.rb', line 48

def partial_result_token
  attributes.fetch(:partialResultToken)
end

#position ⇒ Position

The position inside the text document.

Returns:



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

def position
  attributes.fetch(:position)
end

#text_document ⇒ TextDocumentIdentifier

The text document.

Returns:



23
24
25
 
# File 'lib/language_server/protocol/interface/document_highlight_params.rb', line 23

def text_document
  attributes.fetch(:textDocument)
end

#to_hash ⇒ Object 



54
55
56
 
# File 'lib/language_server/protocol/interface/document_highlight_params.rb', line 54

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



58
59
60
 
# File 'lib/language_server/protocol/interface/document_highlight_params.rb', line 58

def to_json(*args)
  to_hash.to_json(*args)
end

#work_done_token ⇒ ProgressToken | nil

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

Returns:

  • (ProgressToken | nil) 


39
40
41
 
# File 'lib/language_server/protocol/interface/document_highlight_params.rb', line 39

def work_done_token
  attributes.fetch(:workDoneToken)
end