clang-tools  14.0.0git
Public Attributes | List of all members
clang::clangd::WorkDoneProgressBegin Struct Reference

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

#include <Protocol.h>

Collaboration diagram for clang::clangd::WorkDoneProgressBegin:
Collaboration graph
[legend]

Public Attributes

std::string title
 Mandatory title of the progress operation. More...
 
bool cancellable = false
 Controls if a cancel button should show to allow the user to cancel the long-running operation. More...
 
bool percentage = false
 Optional progress percentage to display (value 100 is considered 100%). More...
 

Detailed Description

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

Definition at line 582 of file Protocol.h.

Member Data Documentation

◆ cancellable

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 592 of file Protocol.h.

◆ percentage

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 603 of file Protocol.h.

◆ title

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 587 of file Protocol.h.


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