Struct ProgressView 

pub struct ProgressView {
    pub current: u64,
    pub total: Option<u64>,
    pub message: Option<String>,
}

How far along an execution is.

Fields

current: u64

Units done.

total: Option<u64>

Units in total, when the handler knows how many.

message: Option<String>

What is being done, for a reader.

Implementations

impl ProgressView

pub fn percent(&self) -> Option<u64>

The fraction done, 0..=100, when a total is known.

use majordomus_cli::execution::ProgressView;
let p = ProgressView { current: 3, total: Some(4), message: None };
assert_eq!(p.percent(), Some(75));
let open = ProgressView { current: 3, total: None, message: None };
assert_eq!(open.percent(), None);

Trait Implementations

impl Clone for ProgressView

fn clone(&self) -> ProgressView

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressView

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for ProgressView

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Eq for ProgressView

impl JsonSchema for ProgressView

fn schema_name() -> Cow<'static, str>

The name of the generated JSON Schema.

fn schema_id() -> Cow<'static, str>

Returns a string that uniquely identifies the schema produced by this type.

fn json_schema(generator: &mut SchemaGenerator) -> Schema

Generates a JSON Schema for this type.

fn inline_schema() -> bool

Whether JSON Schemas generated for this type should be included directly in parent schemas, rather than being re-used where possible using the $ref keyword.

impl PartialEq for ProgressView

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

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 ProgressView