class LanguageServer::Protocol::Interface::RelatedFullDocumentDiagnosticReport

A full diagnostic report with a set of related documents.

Attributes

attributes[R]

Public Class Methods

new(kind:, result_id: nil, items:, related_documents: nil) click to toggle source

# File lib/language_server/protocol/interface/related_full_document_diagnostic_report.rb, line 8
def initialize(kind:, result_id: nil, items:, related_documents: nil)
  @attributes = {}

  @attributes[:kind] = kind
  @attributes[:resultId] = result_id if result_id
  @attributes[:items] = items
  @attributes[:relatedDocuments] = related_documents if related_documents

  @attributes.freeze
end

Public Instance Methods

items() click to toggle source

The actual items.

@return [Diagnostic

# File lib/language_server/protocol/interface/related_full_document_diagnostic_report.rb, line 41
def items
  attributes.fetch(:items)
end

kind() click to toggle source

A full document diagnostic report.

@return [any]

# File lib/language_server/protocol/interface/related_full_document_diagnostic_report.rb, line 23
def kind
  attributes.fetch(:kind)
end

related_documents() click to toggle source

Diagnostics of related documents. This information is useful in programming languages where code in a file A can generate diagnostics in a file B which A depends on. An example of such a language is C/C++ where marco definitions in a file a.cpp and result in errors in a header file b.hpp.

@return [{ [uri: string]: FullDocumentDiagnosticReport | UnchangedDocumentDiagnosticReport; }]

# File lib/language_server/protocol/interface/related_full_document_diagnostic_report.rb, line 53
def related_documents
  attributes.fetch(:relatedDocuments)
end

result_id() click to toggle source

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

@return [string]

# File lib/language_server/protocol/interface/related_full_document_diagnostic_report.rb, line 33
def result_id
  attributes.fetch(:resultId)
end

to_hash() click to toggle source

# File lib/language_server/protocol/interface/related_full_document_diagnostic_report.rb, line 59
def to_hash
  attributes
end

to_json(*args) click to toggle source

# File lib/language_server/protocol/interface/related_full_document_diagnostic_report.rb, line 63
def to_json(*args)
  to_hash.to_json(*args)
end