struct LSP::WorkDoneProgressReport

LSP::WorkDoneProgressReport
Struct
Value
Object

Overview

Reporting progress is done using the following payload.

Included Modules

Defined in:

base/work_done_progress.cr

Constructors

.new(pull : JSON::PullParser)
.new(**args)

Instance Method Summary

#cancellable : Bool?
Controls enablement state of a cancel button.
#cancellable=(cancellable : Bool?)
Controls enablement state of a cancel button.
#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%).

Constructor Detail

def self.new(pull : JSON::PullParser) #

def self.new(**args) #

Instance Method Detail

def cancellable : Bool? #

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.

def cancellable=(cancellable : Bool?) #

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.

def message : String? #

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.

def message=(message : String?) #