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

#include <Protocol.h>

Public Attributes
std::string	title
	Mandatory title of the progress operation.

bool	cancellable = false
	Controls if a cancel button should show to allow the user to cancel the long-running operation.

bool	percentage = false
	Optional progress percentage to display (value 100 is considered 100%).

Detailed Description

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

Definition at line 666 of file Protocol.h.

Member Data Documentation

bool clang::clangd::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 676 of file Protocol.h.

bool clang::clangd::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 687 of file Protocol.h.

std::string clang::clangd::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 671 of file Protocol.h.

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