lspserver::WorkDoneProgressBegin Struct Reference

#include <Protocol.h>

Public Attributes
std::string	title
bool	cancellable = false
bool	percentage = false

Detailed Description

To start progress reporting a $/progress notification with the following payload must be sent.

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

Member Data Documentation

cancellable

bool lspserver::WorkDoneProgressBegin::cancellable = false

Controls if a cancel button should show to allow the user to cancel the long-running operation. Clients that don't support cancellation are allowed to ignore the setting.

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

Referenced by lspserver::toJSON().

percentage

bool lspserver::WorkDoneProgressBegin::percentage = false

Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the percentage value in subsequent in report notifications.

The value should be steadily rising. Clients are free to ignore values that are not following this rule.

Clangd implementation note: we only send nonzero percentages in the WorkProgressReport. 'true' here means percentages will be used.

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

Referenced by lspserver::toJSON().

title

std::string lspserver::WorkDoneProgressBegin::title

Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed.

Examples: "Indexing" or "Linking dependencies".

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

Referenced by lspserver::toJSON().

---

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

• lspserver/include/lspserver/Protocol.h