#include <Protocol.h>

Public Attributes
std::string	label
CompletionItemKind	kind = CompletionItemKind::Missing
std::string	detail
std::optional< MarkupContent >	documentation
	A human-readable string that represents a doc-comment.
std::string	sortText
std::string	filterText
std::string	insertText
InsertTextFormat	insertTextFormat = InsertTextFormat::Missing
std::optional< TextEdit >	textEdit
std::vector< TextEdit >	additionalTextEdits
bool	deprecated = false
	Indicates if this item is deprecated.
float	score = 0.f
std::string	data

Detailed Description

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

Member Data Documentation

◆ additionalTextEdits

std::vector<TextEdit> lspserver::CompletionItem::additionalTextEdits

An optional array of additional text edits that are applied when selecting this completion. Edits must not overlap with the main edit nor with themselves.

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

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

◆ data

std::string lspserver::CompletionItem::data

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

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

◆ deprecated

bool lspserver::CompletionItem::deprecated = false

Indicates if this item is deprecated.

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

Referenced by lspserver::toJSON().

◆ detail

std::string lspserver::CompletionItem::detail

A human-readable string with additional information about this item, like type or symbol information.

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

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

◆ documentation

std::optional<MarkupContent> lspserver::CompletionItem::documentation

A human-readable string that represents a doc-comment.

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

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

◆ filterText

std::string lspserver::CompletionItem::filterText

A string that should be used when filtering a set of completion items. When falsy the label is used.

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

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

◆ insertText

std::string lspserver::CompletionItem::insertText

A string that should be inserted to a document when selecting this completion. When falsy the label is used.

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

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

◆ insertTextFormat

InsertTextFormat lspserver::CompletionItem::insertTextFormat = InsertTextFormat::Missing

The format of the insert text. The format applies to both the insertText property and the newText property of a provided textEdit.

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

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

◆ kind

CompletionItemKind lspserver::CompletionItem::kind = CompletionItemKind::Missing

The kind of this completion item. Based of the kind an icon is chosen by the editor.

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

Referenced by lspserver::fromJSON(), and lspserver::toJSON().

◆ label

std::string lspserver::CompletionItem::label

The label of this completion item. By default also the text that is inserted when selecting this completion.

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

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

◆ score

float lspserver::CompletionItem::score = 0.f

The score that clangd calculates to rank the returned completions. This excludes the fuzzy-match between filterText and the partial word. This can be used to re-rank results as the user types, using client-side fuzzy-matching (that score should be multiplied with this one). This is a clangd extension.

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

Referenced by lspserver::toJSON().