Class: LanguageServer::Protocol::Interface::Hover

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

Overview

The result of a hover request.

Instance Attribute Summary collapse

Instance Method Summary collapse

Constructor Details

#initialize(contents:, range: nil) ⇒ Hover

Returns a new instance of Hover.



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

def initialize(contents:, range: nil)
  @attributes = {}

  @attributes[:contents] = contents
  @attributes[:range] = range if range

  @attributes.freeze
end

Instance Attribute Details

#attributes ⇒ Object (readonly)

Returns the value of attribute attributes.



34
35
36
 
# File 'lib/language_server/protocol/interface/hover.rb', line 34

def attributes
  @attributes
end

Instance Method Details

#contents ⇒ MarkupContent | MarkedString | MarkedString[]

The hover’s content

Returns:



21
22
23
 
# File 'lib/language_server/protocol/interface/hover.rb', line 21

def contents
  attributes.fetch(:contents)
end

#range ⇒ Range

An optional range is a range inside a text document that is used to visualize a hover, e.g. by changing the background color.

Returns:



30
31
32
 
# File 'lib/language_server/protocol/interface/hover.rb', line 30

def range
  attributes.fetch(:range)
end

#to_hash ⇒ Object 



36
37
38
 
# File 'lib/language_server/protocol/interface/hover.rb', line 36

def to_hash
  attributes
end

#to_json(*args) ⇒ Object 



40
41
42
 
# File 'lib/language_server/protocol/interface/hover.rb', line 40

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