Struct ProgressUpdateEvent

pub struct ProgressUpdateEvent {
    pub progress_id: String,
    pub message: Option<String>,
    pub percentage: Option<u64>,
}

The event signals that the progress reporting needs to be updated with a new message and/or percentage. The client does not have to update the UI immediately, but the clients needs to keep track of the message and/or percentage values. This event should only be sent if the corresponding capability supportsProgressReporting is true.

Fields

progress_id: String

The ID that was introduced in the initial progressStart event.

message: Option<String>

More detailed progress message. If omitted, the previous message (if any) is used.

percentage: Option<u64>

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

Trait Implementations

impl Clone for ProgressUpdateEvent

fn clone(&self) -> ProgressUpdateEvent

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressUpdateEvent

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressUpdateEvent

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for ProgressUpdateEvent

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

where __S: Serializer,

Serialize this value into the given Serde serializer.