Struct ProgressUpdateEventBody

pub struct ProgressUpdateEventBody {
    pub progress_id: String,
    pub message: Option<String>,
    pub percentage: Option<u8>,
    /* private fields */
}

Fields

progress_id: String

The ID that was introduced in the initial ‘progressStart’ event.

message: Option<String>

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

percentage: Option<u8>

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

Implementations

impl ProgressUpdateEventBody

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

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

Trait Implementations

impl Clone for ProgressUpdateEventBody

fn clone(&self) -> ProgressUpdateEventBody

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressUpdateEventBody

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressUpdateEventBody

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl From<ProgressUpdateEventBody> for Event

fn from(body: ProgressUpdateEventBody) -> Self

Converts to this type from the input type.

impl From<ProgressUpdateEventBody> for ProtocolMessageContent

fn from(body: ProgressUpdateEventBody) -> Self

Converts to this type from the input type.

impl PartialEq for ProgressUpdateEventBody

fn eq(&self, other: &ProgressUpdateEventBody) -> 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 ProgressUpdateEventBody

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 ProgressUpdateEventBody

impl StructuralPartialEq for ProgressUpdateEventBody