Struct OperationProgress

#[non_exhaustive]
pub struct OperationProgress {
    pub name: String,
    pub status: Status,
    pub metrics: Vec<Metric>,
    pub stages: Vec<OperationProgress>,
    /* private fields */
}

Information about operation (or operation stage) progress.

Fields (Non-exhaustive)

Non-exhaustive structs could have additional fields added in future. Therefore, non-exhaustive structs cannot be constructed in external crates using the traditional Struct { .. } syntax; cannot be matched against without a wildcard ..; and struct update syntax will not work.

name: String

A non-parameterized string describing an operation stage. Unset for single-stage operations.

status: Status

Status of an operation stage. Unset for single-stage operations.

metrics: Vec<Metric>

Progress metric bundle, for example: metrics: [{name: “nodes done”, int_value: 15}, {name: “nodes total”, int_value: 32}] or metrics: [{name: “progress”, double_value: 0.56}, {name: “progress scale”, double_value: 1.0}]

stages: Vec<OperationProgress>

Substages of an operation or a stage.

Implementations

impl OperationProgress

pub fn new() -> Self

pub fn set_name<T: Into<String>>(self, v: T) -> Self

Sets the value of name.

pub fn set_status<T: Into<Status>>(self, v: T) -> Self

Sets the value of status.

pub fn set_metrics<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<Metric>,

Sets the value of metrics.

pub fn set_stages<T, V>(self, v: T) -> Self

where T: IntoIterator<Item = V>, V: Into<OperationProgress>,

Sets the value of stages.

Trait Implementations

impl Clone for OperationProgress

fn clone(&self) -> OperationProgress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for OperationProgress

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

Formats the value using the given formatter.

impl Default for OperationProgress

fn default() -> OperationProgress

Returns the “default value” for a type.

impl Message for OperationProgress

fn typename() -> &'static str

The typename of this message.

impl PartialEq for OperationProgress

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