class LSProtocol::InlayHint

Overview

Inlay hint information.

@since 3.17.0

Included Modules

Defined in:

lsprotocol/types.cr

Constructors

Instance Method Summary

Constructor Detail

def self.new(label : Array(InlayHintLabelPart) | String | Nil, position : Position | Nil, data : LSPAny | Nil = nil, kind : InlayHintKind | Nil = nil, padding_left : Bool | Nil = nil, padding_right : Bool | Nil = nil, text_edits : Array(TextEdit) | Nil = nil, tooltip : MarkupContent | String | Nil = nil) #

[View source]
def self.new(pull : JSON::PullParser) #

[View source]

Instance Method Detail

def data : LSPAny | Nil #

A data entry field that is preserved on an inlay hint between a textDocument/inlayHint and a inlayHint/resolve request.


[View source]
def kind : InlayHintKind | Nil #

The kind of this hint. Can be omitted in which case the client should fall back to a reasonable default.


[View source]
def label : Array(InlayHintLabelPart) | String #

The label of this hint. A human readable string or an array of InlayHintLabelPart label parts.

Note that neither the string nor the label part can be empty.


[View source]
def padding_left : Bool | Nil #

[View source]
def padding_right : Bool | Nil #

[View source]
def position : Position #

The position of this hint.

If multiple hints have the same position, they will be shown in the order they appear in the response.


[View source]
def text_edits : Array(TextEdit) | Nil #

[View source]
def tooltip : MarkupContent | String | Nil #

The tooltip text when you hover over this item.


[View source]