Struct ProgressStartEventBody 

pub struct ProgressStartEventBody {
    pub progress_id: String,
    pub title: String,
    pub request_id: Option<i64>,
    pub cancellable: Option<bool>,
    pub message: Option<String>,
    pub percentage: Option<i64>,
}

Arguments for a ProgressStart event.

Fields

progress_id: String

An ID that can be used in subsequent progressUpdate and progressEnd events to make them refer to the same progress reporting. IDs must be unique within a debug session.

title: String

Short title of the progress reporting. Shown in the UI to describe the long running operation.

request_id: Option<i64>

The request ID that this progress report is related to. If specified a debug adapter is expected to emit progress events for the long running request until the request has been either completed or cancelled. If the request ID is omitted, the progress report is assumed to be related to some general activity of the debug adapter.

cancellable: Option<bool>

If true, the request that reports progress may be cancelled with a cancel request. So this property basically controls whether the client should use UX that supports cancellation. Clients that don’t support cancellation are allowed to ignore the setting.

message: Option<String>

More detailed progress message.

percentage: Option<i64>

Progress percentage to display (value range: 0 to 100). If omitted no percentage is shown.

Trait Implementations

impl Clone for ProgressStartEventBody

fn clone(&self) -> ProgressStartEventBody

Returns a duplicate of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl Debug for ProgressStartEventBody

fn fmt(&self, f: &mut Formatter<'_>) -> Result

Formats the value using the given formatter.

impl Default for ProgressStartEventBody

fn default() -> ProgressStartEventBody

Returns the “default value” for a type.

impl Serialize for ProgressStartEventBody

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.