Struct Progress 

pub struct Progress {
    pub current: u64,
    pub total: Option<u64>,
    pub unit: Option<String>,
}

Progress information for long-running operations.

Example

use orcs_component::Progress;

// Determinate progress (known total)
let progress = Progress::new(50, Some(100))
    .with_unit("files");
assert_eq!(progress.percentage(), Some(50.0));

// Indeterminate progress (unknown total)
let progress = Progress::new(42, None);
assert_eq!(progress.percentage(), None);

Fields

current: u64

Current progress value.

total: Option<u64>

Total value (if known).

unit: Option<String>

Unit of measurement (e.g., “files”, “tokens”, “bytes”).

Implementations

impl Progress

pub fn new(current: u64, total: Option<u64>) -> Self

Creates a new Progress.

Arguments

• current - Current progress value
• total - Total value (None for indeterminate)

pub fn with_unit(self, unit: impl Into<String>) -> Self

Sets the unit of measurement.

pub fn percentage(&self) -> Option<f64>

Returns the progress as a percentage (0.0 - 100.0).

Returns None if total is unknown or zero.

Example

use orcs_component::Progress;

let progress = Progress::new(25, Some(100));
assert_eq!(progress.percentage(), Some(25.0));

let progress = Progress::new(42, None);
assert_eq!(progress.percentage(), None);

pub fn is_complete(&self) -> bool

Returns true if progress is complete.

Example

use orcs_component::Progress;

let progress = Progress::new(100, Some(100));
assert!(progress.is_complete());

let progress = Progress::new(50, Some(100));
assert!(!progress.is_complete());

Trait Implementations

impl Clone for Progress

fn clone(&self) -> Progress

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for Progress

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for Progress

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Serialize for Progress

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

where __S: Serializer,

Serialize this value into the given Serde serializer.