Struct WorkDoneProgressBegin

pub struct WorkDoneProgressBegin {
    pub title: String,
    pub cancellable: Option<bool>,
    pub message: Option<String>,
    pub percentage: Option<u32>,
}

Fields

title: String

Mandatory title of the progress operation. Used to briefly inform about the kind of operation being performed. Examples: “Indexing” or “Linking dependencies”.

cancellable: Option<bool>

Controls if a cancel button should show to allow the user to cancel the long running operation. Clients that don’t support cancellation are allowed to ignore the setting.

message: Option<String>

Optional, more detailed associated progress message. Contains complementary information to the title.

Examples: “3/25 files”, “project/src/module2”, “node_modules/some_dep”. If unset, the previous progress message (if any) is still valid.

percentage: Option<u32>

Optional progress percentage to display (value 100 is considered 100%). If not provided infinite progress is assumed and clients are allowed to ignore the percentage value in subsequent in report notifications.

The value should be steadily rising. Clients are free to ignore values that are not following this rule. The value range is [0, 100]

Trait Implementations

impl Clone for WorkDoneProgressBegin

fn clone(&self) -> WorkDoneProgressBegin

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for WorkDoneProgressBegin

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

Formats the value using the given formatter.

impl Default for WorkDoneProgressBegin

fn default() -> WorkDoneProgressBegin

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for WorkDoneProgressBegin

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for WorkDoneProgressBegin

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

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

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 WorkDoneProgressBegin

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

where __S: Serializer,

Serialize this value into the given Serde serializer.

impl StructuralPartialEq for WorkDoneProgressBegin