Struct ProgressSchema 

pub struct ProgressSchema { /* private fields */ }

Metric dictionary for one logical progress operation.

A schema defines which metric ids are valid for the operation. Events carry a schema so every serialized progress event is self-describing and reporters can resolve metric ids to display names without external state.

Implementations

impl ProgressSchema

pub fn new(metrics: Vec<ProgressMetric>) -> Self

Creates a schema from metric definitions.

Parameters

• metrics - Metric definitions available to events using this schema.

Returns

A schema containing the supplied metric definitions.

pub fn single(id: &str, name: &str) -> Self

Creates a schema containing one metric.

Parameters

• id - Stable metric identifier.
• name - Human-readable metric name.

Returns

A schema with a single metric definition.

pub fn metrics(&self) -> &[ProgressMetric]

Returns all metric definitions.

Returns

A slice of metrics declared by this schema.

pub fn metric(&self, id: &str) -> Option<&ProgressMetric>

Finds a metric by id.

Parameters

• id - Metric identifier to search for.

Returns

Some(metric) when the schema contains the id, otherwise None.

pub fn metric_name(&self, id: &str) -> Option<&str>

Finds a metric display name by id.

Parameters

• id - Metric identifier to search for.

Returns

Some(name) when the schema contains the id, otherwise None.

pub fn contains_metric(&self, id: &str) -> bool

Checks whether the schema contains a metric id.

Parameters

• id - Metric identifier to test.

Returns

true when this schema contains id.

pub fn validate_counter(&self, counter: &ProgressCounter) -> bool

Validates one counter against this schema.

Parameters

• counter - Counter to validate.

Returns

true when counter.metric_id() exists in this schema.

pub fn validate_counters(&self, counters: &[ProgressCounter]) -> bool

Validates counters against this schema.

Validation is intentionally light-weight: every counter metric id must exist in the schema and each metric id may appear at most once in the event. Numeric relationships are not validated because many operations discover totals dynamically or apply retry and compensation logic.

Parameters

• counters - Counters to validate.

Returns

true when all counters reference declared metrics and no metric id is duplicated.

Trait Implementations

impl Clone for ProgressSchema

fn clone(&self) -> ProgressSchema

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressSchema

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

Formats the value using the given formatter.

impl Default for ProgressSchema

fn default() -> Self

Creates an empty schema.

Returns

A schema without declared metrics.

impl<'de> Deserialize<'de> for ProgressSchema

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl PartialEq for ProgressSchema

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

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 ProgressSchema

impl StructuralPartialEq for ProgressSchema