lspserver::WorkDoneProgressReport Struct Reference

Reporting progress is done using the following payload. More...

#include <Protocol.h>

Public Attributes
std::string	title
std::optional< bool >	cancellable
std::optional< std::string >	message
std::optional< unsigned >	percentage

Detailed Description

Reporting progress is done using the following payload.

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

Member Data Documentation

cancellable

std::optional<bool> lspserver::WorkDoneProgressReport::cancellable

Controls enablement state of a cancel button. This property is only valid if a cancel button got requested in the WorkDoneProgressStart payload.

Clients that don't support cancellation or don't support control the button's enablement state are allowed to ignore the setting.

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

Referenced by lspserver::toJSON().

message

std::optional<std::string> lspserver::WorkDoneProgressReport::message

Optional, more detailed associated progress message. Contains complementary information to the title.

Examples: "3/25 files", "project/src/module2", "node_modules/some_dep". If unset, the previous progress message (if any) is still valid.

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

Referenced by lspserver::toJSON().

percentage

std::optional<unsigned> lspserver::WorkDoneProgressReport::percentage

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.

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

Referenced by lspserver::toJSON().

title

std::string lspserver::WorkDoneProgressReport::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 668 of file lspserver/include/lspserver/Protocol.h.

---

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

• lspserver/include/lspserver/Protocol.h