lspserver::InlayHint Struct Reference

Inlay hint information. More...

#include <Protocol.h>

Collaboration diagram for lspserver::InlayHint:

Public Attributes
Position	position
	The position of this hint.
std::string	label
InlayHintKind	kind
bool	paddingLeft = false
bool	paddingRight = false
Range	range

Detailed Description

Inlay hint information.

Definition at line 1615 of file lspserver/include/lspserver/Protocol.h.

Member Data Documentation

kind

InlayHintKind lspserver::InlayHint::kind

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

Definition at line 1627 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::operator<(), lspserver::operator==(), and lspserver::toJSON().

label

std::string lspserver::InlayHint::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.

Definition at line 1623 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::operator<(), lspserver::operator==(), and lspserver::toJSON().

paddingLeft

bool lspserver::InlayHint::paddingLeft = false

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.

Definition at line 1634 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::toJSON().

paddingRight

bool lspserver::InlayHint::paddingRight = false

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.

Definition at line 1641 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::toJSON().

position

Position lspserver::InlayHint::position

The position of this hint.

Definition at line 1617 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::operator<(), lspserver::operator==(), and lspserver::toJSON().

range

Range lspserver::InlayHint::range

The range of source code to which the hint applies.

For example, a parameter hint may have the argument as its range. The range allows clients more flexibility of when/how to display the hint. This is an (unserialized) clangd extension.

Definition at line 1648 of file lspserver/include/lspserver/Protocol.h.

Referenced by lspserver::operator<(), and lspserver::operator==().

---

The documentation for this struct was generated from the following file:

• lspserver/include/lspserver/Protocol.h