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

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

#include <Protocol.h>

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

Public Attributes

std::string title
 Mandatory title of the progress operation. More...
 
llvm::Optional< bool > cancellable
 Controls enablement state of a cancel button. More...
 
llvm::Optional< std::string > message
 Optional, more detailed associated progress message. More...
 
llvm::Optional< unsigned > percentage
 Optional progress percentage to display (value 100 is considered 100%). More...
 

Detailed Description

Reporting progress is done using the following payload.

Definition at line 608 of file Protocol.h.

Member Data Documentation

◆ cancellable

llvm::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 620 of file Protocol.h.

◆ message

llvm::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 627 of file Protocol.h.

◆ percentage

llvm::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 635 of file Protocol.h.

◆ title

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


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