Struct Progress 

pub struct Progress {
    pub width: usize,
    pub full_char: char,
    pub full_color: String,
    pub empty_char: char,
    pub empty_color: String,
    pub show_percentage: bool,
    pub percent_format: String,
    pub percentage_style: Style,
    /* private fields */
}

Progress bar model.

Fields

width: usize

Total width of the progress bar.

full_char: char

Character for filled sections.

full_color: String

Color for filled sections (when not using gradient).

empty_char: char

Character for empty sections.

empty_color: String

Color for empty sections.

show_percentage: bool

Whether to show percentage text.

percent_format: String

Format string for percentage.

percentage_style: Style

Style for percentage text.

Implementations

impl Progress

pub fn new() -> Self

Creates a new progress bar with default settings.

pub fn with_gradient() -> Self

Creates a progress bar with default gradient colors.

pub fn with_gradient_colors(color_a: &str, color_b: &str) -> Self

Creates a progress bar with custom gradient colors.

pub fn with_scaled_gradient(color_a: &str, color_b: &str) -> Self

Creates a progress bar with a scaled gradient.

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

Sets the width of the progress bar.

pub fn fill_chars(self, full: char, empty: char) -> Self

Sets the fill characters.

pub fn solid_fill(self, color: &str) -> Self

Sets the solid fill color (disables gradient).

pub fn without_percentage(self) -> Self

Disables percentage display.

pub fn set_spring_options(&mut self, frequency: f64, damping: f64)

Sets the spring animation parameters.

pub fn id(&self) -> u64

Returns the progress bar’s unique ID.

pub fn percent(&self) -> f64

Returns the current target percentage.

pub fn set_percent(&mut self, p: f64) -> Option<Cmd>

Sets the percentage and returns a command to start animation.

pub fn incr_percent(&mut self, v: f64) -> Option<Cmd>

Increments the percentage.

pub fn decr_percent(&mut self, v: f64) -> Option<Cmd>

Decrements the percentage.

pub fn is_animating(&self) -> bool

Returns whether the progress bar is still animating.

pub fn update(&mut self, msg: Message) -> Option<Cmd>

Updates the progress bar state.

pub fn view(&self) -> String

Renders the progress bar at the current animated position.

pub fn view_as(&self, percent: f64) -> String

Renders the progress bar at a specific percentage.

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 Default for Progress

fn default() -> Self

Returns the “default value” for a type.

impl Model for Progress

fn init(&self) -> Option<Cmd>

Initialize the progress bar.

Progress bars don’t require initialization commands.

fn update(&mut self, msg: Message) -> Option<Cmd>

Update the progress bar state based on incoming messages.

fn view(&self) -> String

Render the progress bar at the current animated position.