struct LSP::WorkDoneProgressBegin
- LSP::WorkDoneProgressBegin
- Struct
- Value
- Object
Overview
To start progress reporting a $/progress notification with the following payload must be sent.
Included Modules
Defined in:
base/work_done_progress.crConstructors
Instance Method Summary
-
#cancellable : Bool?
Controls if a cancel button should show to allow the user to cancel the long running operation.
-
#cancellable=(cancellable : Bool?)
Controls if a cancel button should show to allow the user to cancel the long running operation.
-
#message : String?
Optional, more detailed associated progress message.
-
#message=(message : String?)
Optional, more detailed associated progress message.
-
#percentage : Int32?
Optional progress percentage to display (value 100 is considered 100%).
-
#percentage=(percentage : Int32?)
Optional progress percentage to display (value 100 is considered 100%).
-
#title : String
Mandatory title of the progress operation.
-
#title=(title : String)
Mandatory title of the progress operation.
Constructor Detail
Instance Method Detail
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.
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.
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.
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.
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.
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.
Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed.
Examples: "Indexing" or "Linking dependencies".
Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed.
Examples: "Indexing" or "Linking dependencies".