clang-tools 20.0.0git
|
Reporting progress is done using the following payload. More...
#include <Protocol.h>
Public Attributes | |
std::string | title |
Mandatory title of the progress operation. | |
std::optional< bool > | cancellable |
Controls enablement state of a cancel button. | |
std::optional< std::string > | message |
Optional, more detailed associated progress message. | |
std::optional< unsigned > | percentage |
Optional progress percentage to display (value 100 is considered 100%). | |
Reporting progress is done using the following payload.
Definition at line 689 of file Protocol.h.
std::optional<bool> clang::clangd::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 701 of file Protocol.h.
Referenced by clang::clangd::toJSON().
std::optional<std::string> clang::clangd::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 708 of file Protocol.h.
Referenced by clang::clangd::toJSON().
std::optional<unsigned> clang::clangd::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 716 of file Protocol.h.
Referenced by clang::clangd::toJSON().
std::string clang::clangd::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 694 of file Protocol.h.