Class: LanguageServer::Protocol::Interface::WorkspaceDocumentDiagnosticReport

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

Overview

A workspace diagnostic document report.

Since:

  • 3.17.0

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(uri:, version:, kind:, result_id: nil, items:) ⇒ WorkspaceDocumentDiagnosticReport

Returns a new instance of WorkspaceDocumentDiagnosticReport.

Since:

  • 3.17.0



10
11
12
13
14
15
16
17
18
19
20
# File 'lib/language_server/protocol/interface/workspace_document_diagnostic_report.rb', line 10

def initialize(uri:, version:, kind:, result_id: nil, items:)
  @attributes = {}

  @attributes[:uri] = uri
  @attributes[:version] = version
  @attributes[:kind] = kind
  @attributes[:resultId] = result_id if result_id
  @attributes[:items] = items

  @attributes.freeze
end

Instance Attribute Details

#attributesObject (readonly)

Since:

  • 3.17.0



65
66
67
# File 'lib/language_server/protocol/interface/workspace_document_diagnostic_report.rb', line 65

def attributes
  @attributes
end

Instance Method Details

#itemsDiagnostic[]

The actual items.

Returns:

Since:

  • 3.17.0



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

def items
  attributes.fetch(:items)
end

#kind"full"

A full document diagnostic report.

Returns:

  • ("full")

Since:

  • 3.17.0



43
44
45
# File 'lib/language_server/protocol/interface/workspace_document_diagnostic_report.rb', line 43

def kind
  attributes.fetch(:kind)
end

#result_idstring | nil

An optional result id. If provided it will be sent on the next diagnostic request for the same document.

Returns:

  • (string | nil)

Since:

  • 3.17.0



53
54
55
# File 'lib/language_server/protocol/interface/workspace_document_diagnostic_report.rb', line 53

def result_id
  attributes.fetch(:resultId)
end

#to_hashObject

Since:

  • 3.17.0



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

def to_hash
  attributes
end

#to_json(*args) ⇒ Object

Since:

  • 3.17.0



71
72
73
# File 'lib/language_server/protocol/interface/workspace_document_diagnostic_report.rb', line 71

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

#uriDocumentUri

The URI for which diagnostic information is reported.

Returns:

  • (DocumentUri)

Since:

  • 3.17.0



26
27
28
# File 'lib/language_server/protocol/interface/workspace_document_diagnostic_report.rb', line 26

def uri
  attributes.fetch(:uri)
end

#versioninteger | null

The version number for which the diagnostics are reported. If the document is not marked as open null can be provided.

Returns:

  • (integer | null)

Since:

  • 3.17.0



35
36
37
# File 'lib/language_server/protocol/interface/workspace_document_diagnostic_report.rb', line 35

def version
  attributes.fetch(:version)
end