Struct ProgressStartEvent

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

The event signals that a long running operation is about to start and provides additional information for the client to set up a corresponding progress and cancellation UI. The client is free to delay the showing of the UI in order to reduce flicker. This event should only be sent if the corresponding capability supportsProgressReporting is true.

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<u64>

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<u64>

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

Trait Implementations

impl Clone for ProgressStartEvent

fn clone(&self) -> ProgressStartEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressStartEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressStartEvent

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProgressStartEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.