class

LSProtocol::InlayHint

Inherits JSON::Serializable / Reference / Object

Inlay hint information.

@since 3.17.0

Constructors

new(pull : JSON::PullParser)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

Instance methods

data

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

Source

kind

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

Source

label

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.

Source

padding_left

Render padding before the hint.

Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

Source

padding_right

Render padding after the hint.

Note: Padding should use the editor's background color, not the background color of the hint itself. That means padding can be used to visually align/separate an inlay hint.

Source

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.

Source

text_edits

Optional text edits that are performed when accepting this inlay hint.

Note that edits are expected to change the document so that the inlay hint (or its nearest variant) is now part of the document and the inlay hint itself is now obsolete.

Source