Class: LanguageServer::Protocol::Interface::DocumentDiagnosticParams

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

Overview

Parameters of the document diagnostic request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(work_done_token: nil, partial_result_token: nil, text_document:, identifier: nil, previous_result_id: nil) ⇒ DocumentDiagnosticParams

Returns a new instance of DocumentDiagnosticParams.



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

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

  @attributes[:workDoneToken] = work_done_token if work_done_token
  @attributes[:partialResultToken] = partial_result_token if partial_result_token
  @attributes[:textDocument] = text_document
  @attributes[:identifier] = identifier if identifier
  @attributes[:previousResultId] = previous_result_id if previous_result_id

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



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

def attributes
  @attributes
end

Instance Method Details

#identifier ⇒ string

The additional identifier provided during registration.

Returns:

  • (string) 


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

def identifier
  attributes.fetch(:identifier)
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/document_diagnostic_params.rb', line 33

def partial_result_token
  attributes.fetch(:partialResultToken)
end

#previous_result_id ⇒ string

The result id of a previous response if provided.

Returns:

  • (string) 


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

def previous_result_id
  attributes.fetch(:previousResultId)
end

#text_document ⇒ TextDocumentIdentifier

The text document.

Returns:



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

def text_document
  attributes.fetch(:textDocument)
end

#to_hash ⇒ Object 



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

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



67
68
69
 
# File 'lib/language_server/protocol/interface/document_diagnostic_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/document_diagnostic_params.rb', line 24

def work_done_token
  attributes.fetch(:workDoneToken)
end