class LanguageServer::Protocol::Interface::DocumentLink
A document link is a range in a text document that links to an internal or external resource, like another text document or a web site.
Attributes
attributes[R]
Public Class Methods
new(range:, target: nil, tooltip: nil, data: nil)
click to toggle source
# File lib/language_server/protocol/interface/document_link.rb, line 9 def initialize(range:, target: nil, tooltip: nil, data: nil) @attributes = {} @attributes[:range] = range @attributes[:target] = target if target @attributes[:tooltip] = tooltip if tooltip @attributes[:data] = data if data @attributes.freeze end
Public Instance Methods
data()
click to toggle source
A data entry field that is preserved on a document link between a DocumentLinkRequest and a DocumentLinkResolveRequest.
@return [any]
# File lib/language_server/protocol/interface/document_link.rb, line 54 def data attributes.fetch(:data) end
range()
click to toggle source
The range this link applies to.
@return [Range]
# File lib/language_server/protocol/interface/document_link.rb, line 24 def range attributes.fetch(:range) end
target()
click to toggle source
The uri this link points to. If missing a resolve request is sent later.
@return [string]
# File lib/language_server/protocol/interface/document_link.rb, line 32 def target attributes.fetch(:target) end
to_hash()
click to toggle source
# File lib/language_server/protocol/interface/document_link.rb, line 60 def to_hash attributes end
to_json(*args)
click to toggle source
# File lib/language_server/protocol/interface/document_link.rb, line 64 def to_json(*args) to_hash.to_json(*args) end
tooltip()
click to toggle source
The tooltip text when you hover over this link.
If a tooltip is provided, is will be displayed in a string that includes instructions on how to trigger the link, such as `{0} (ctrl + click)`. The specific instructions vary depending on OS, user settings, and localization.
@return [string]
# File lib/language_server/protocol/interface/document_link.rb, line 45 def tooltip attributes.fetch(:tooltip) end