struct

LSP::WorkDoneProgressReport

Inherits JSON::Serializable < LSP::Initializer < Struct < Value < Object

Reporting progress is done using the following payload.

Constructors

new(pull : JSON::PullParser)

Source

new(*, __pull_for_json_serializable pull : JSON::PullParser)

Source

new

Source

Instance methods

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.

Source

cancellable=(cancellable : Bool | Nil)

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.

Source

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.

Source

message=(message : String | Nil)

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.

Source

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.

Source

percentage=(percentage : Int32 | Nil)

The value should be steadily rising. Clients are free to ignore values that are not following this rule.

Source