Struct ProgressStartEventBody

pub struct ProgressStartEventBody {
    pub progress_id: String,
    pub title: String,
    pub request_id: Option<i32>,
    pub cancellable: bool,
    pub message: Option<String>,
    pub percentage: Option<u8>,
    /* private fields */
}

Fields

progress_id: String

An ID that must 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

Mandatory (short) title of the progress reporting. Shown in the UI to describe the long running operation.

request_id: Option<i32>

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: bool

If true, the request that reports progress may be canceled 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>

Optional, more detailed progress message.

percentage: Option<u8>

Optional progress percentage to display (value range: 0 to 100). If omitted no percentage will be shown.

Implementations

impl ProgressStartEventBody

pub fn builder() -> ProgressStartEventBodyBuilder<((), (), (), (), (), ())>

Create a builder for building ProgressStartEventBody. On the builder, call .progress_id(...), .title(...), .request_id(...)(optional), .cancellable(...)(optional), .message(...)(optional), .percentage(...)(optional) to set the values of the fields. Finally, call .build() to create the instance of ProgressStartEventBody.

Trait Implementations

impl Clone for ProgressStartEventBody

fn clone(&self) -> ProgressStartEventBody

Returns a duplicate of the value.

const 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<'de> Deserialize<'de> for ProgressStartEventBody

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ProgressStartEventBody> for Event

fn from(body: ProgressStartEventBody) -> Self

Converts to this type from the input type.

impl From<ProgressStartEventBody> for ProtocolMessageContent

fn from(body: ProgressStartEventBody) -> Self

Converts to this type from the input type.

impl PartialEq for ProgressStartEventBody

fn eq(&self, other: &ProgressStartEventBody) -> bool

Tests for self and other values to be equal, and is used by ==.

const fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

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.

impl Eq for ProgressStartEventBody

impl StructuralPartialEq for ProgressStartEventBody