Struct ProgressStage 

pub struct ProgressStage { /* private fields */ }

Describes the current stage of a multi-stage operation.

Examples

use qubit_progress::ProgressStage;

let stage = ProgressStage::new("verify", "Verify files")
    .with_index(2)
    .with_total_stages(4)
    .with_weight(0.25);

assert_eq!(stage.id(), "verify");
assert_eq!(stage.name(), "Verify files");
assert_eq!(stage.index(), Some(2));

Implementations

impl ProgressStage

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

Creates a stage with a stable id and display name.

Parameters

• id - Stable machine-readable identifier.
• name - Human-readable stage name.

Returns

A stage with no index, total stage count, or weight.

pub const fn with_index(self, index: usize) -> Self

Returns a copy configured with a zero-based stage index.

Parameters

• index - Zero-based stage index.

Returns

This stage with index recorded.

pub const fn with_total_stages(self, total_stages: usize) -> Self

Returns a copy configured with the total stage count.

Parameters

• total_stages - Total number of stages in the operation.

Returns

This stage with total_stages recorded.

pub const fn with_weight(self, weight: f64) -> Self

Returns a copy configured with a relative stage weight.

The weight is intended for caller-side weighted progress calculations. Callers should supply finite, non-negative values. This method records the supplied value as-is and does not validate NaN, infinity, or negative input.

Parameters

• weight - Finite, non-negative relative stage weight used by callers that compute weighted total progress.

Returns

This stage with weight recorded.

pub fn id(&self) -> &str

Returns the stable stage identifier.

Returns

The machine-readable stage id.

pub fn name(&self) -> &str

Returns the human-readable stage name.

Returns

The display name for this stage.

pub const fn index(&self) -> Option<usize>

Returns the stage index when known.

Returns

Some(index) when a zero-based stage index was supplied, otherwise None.

pub const fn total_stages(&self) -> Option<usize>

Returns the total stage count when known.

Returns

Some(total) when a total stage count was supplied, otherwise None.

pub const fn weight(&self) -> Option<f64>

Returns the relative stage weight when known.

Returns

Some(weight) when a weight was supplied, otherwise None.

Trait Implementations

impl Clone for ProgressStage

fn clone(&self) -> ProgressStage

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for ProgressStage

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

Formats the value using the given formatter.

impl PartialEq for ProgressStage

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