Struct lsp2::InlayHint

pub struct InlayHint {
    pub position: Position,
    pub label: InlayHintLabel,
    pub kind: Option<InlayHintKind>,
    pub text_edits: Option<Vec<TextEdit, Global>>,
    pub tooltip: Option<InlayHintTooltip>,
    pub padding_left: Option<bool>,
    pub padding_right: Option<bool>,
    pub data: Option<Value>,
}

Inlay hint information.

@since 3.17.0

Fields

position: Position

The position of this hint.

label: InlayHintLabel

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.

kind: Option<InlayHintKind>

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

text_edits: Option<Vec<TextEdit, Global>>

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.

Depending on the client capability inlayHint.resolveSupport clients might resolve this property late using the resolve request.

tooltip: Option<InlayHintTooltip>

The tooltip text when you hover over this item.

Depending on the client capability inlayHint.resolveSupport clients might resolve this property late using the resolve request.

padding_left: Option<bool>

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.

padding_right: Option<bool>

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.

data: Option<Value>

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

Trait Implementations

impl Clone for InlayHint

fn clone(&self) -> InlayHint

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for InlayHint

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for InlayHint

fn deserialize<__D>( __deserializer: __D ) -> Result<InlayHint, <__D as Deserializer<'de>>::Error>where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for InlayHint

fn serialize<__S>( &self, __serializer: __S ) -> Result<<__S as Serializer>::Ok, <__S as Serializer>::Error>where __S: Serializer,

Serialize this value into the given Serde serializer.