Struct OperationProgress 

pub struct OperationProgress { /* private fields */ }

A progress bar for operations with known total count.

Tracks completion percentage, calculates throughput rate, and estimates time remaining based on current progress speed.

Rendering Modes

• Rich mode: Colored progress bar with percentage, counter, throughput, ETA
• Plain mode: Text format suitable for agents: Name: 42% (420/1000) 50.2/s ETA: 12s
• JSON mode: Structured data for programmatic consumption

Example

use sqlmodel_console::renderables::OperationProgress;

let mut progress = OperationProgress::new("Processing", 100);
progress.set_completed(50);

assert_eq!(progress.percentage(), 50.0);

Implementations

impl OperationProgress

pub fn new(operation_name: impl Into<String>, total: u64) -> Self

Create a new progress tracker.

Arguments

• operation_name: Human-readable name for the operation
• total: Total number of items to process

pub fn completed(self, completed: u64) -> Self

Set the number of completed items.

pub fn set_completed(&mut self, completed: u64)

Set the number of completed items (mutable version).

pub fn increment(&mut self)

Increment the completed count by one.

pub fn add(&mut self, count: u64)

Add to the completed count.

pub fn theme(self, theme: Theme) -> Self

Set the theme for styled output.

pub fn width(self, width: usize) -> Self

Set the rendering width.

pub fn show_eta(self, show: bool) -> Self

Set whether to show ETA.

pub fn show_throughput(self, show: bool) -> Self

Set whether to show throughput.

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

Set the unit label for items.

pub fn state(self, state: ProgressState) -> Self

Set the state manually (e.g., for error indication).

pub fn reset_timer(&mut self)

Reset the start time (useful when reusing a progress tracker).

pub fn operation_name(&self) -> &str

Get the operation name.

pub fn completed_count(&self) -> u64

Get the completed count.

pub fn total_count(&self) -> u64

Get the total count.

pub fn current_state(&self) -> ProgressState

Get the current state.

pub fn percentage(&self) -> f64

Calculate the completion percentage.

pub fn elapsed_secs(&self) -> f64

Calculate the elapsed time in seconds.

pub fn throughput(&self) -> f64

Calculate the throughput (items per second).

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

Calculate the estimated time remaining in seconds.

pub fn is_complete(&self) -> bool

Check if the operation is complete.

pub fn render_plain(&self) -> String

Render as plain text for agents.

Format: Name: 42% (420/1000) 50.2/s ETA: 12s

pub fn render_styled(&self) -> String

Render with ANSI styling.

Shows a visual progress bar with colors based on state.

pub fn to_json(&self) -> String

Render as JSON for structured output.

Trait Implementations

impl Clone for OperationProgress

fn clone(&self) -> OperationProgress

Returns a duplicate of the value.

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.