Skip to main content

ProgressProps

Struct ProgressProps 

Source
pub struct ProgressProps {
Show 13 fields pub progress: f32, pub width: usize, pub style: ProgressStyle, pub custom_chars: Option<ProgressChars>, pub show_percentage: bool, pub label: Option<String>, pub filled_color: Option<Color>, pub empty_color: Option<Color>, pub text_color: Option<Color>, pub bg_color: Option<Color>, pub brackets: bool, pub bold: bool, pub dim_empty: bool,
}
Expand description

Properties for the Progress component.

Fields§

§progress: f32

Progress value from 0.0 to 1.0.

§width: usize

Width of the progress bar in characters.

§style: ProgressStyle

Progress bar style.

§custom_chars: Option<ProgressChars>

Custom characters (overrides style if set).

§show_percentage: bool

Whether to show percentage text.

§label: Option<String>

Optional label to show before the bar.

§filled_color: Option<Color>

Color for filled portion.

§empty_color: Option<Color>

Color for empty portion.

§text_color: Option<Color>

Color for percentage text.

§bg_color: Option<Color>

Background color.

§brackets: bool

Whether to show brackets around the bar.

§bold: bool

Whether the filled portion should be bold.

§dim_empty: bool

Whether the empty portion should be dimmed.

Implementations§

Source§

impl ProgressProps

Source

pub fn new(progress: f32) -> Self

Create new ProgressProps with the given progress value.

Source

pub fn progress(self, progress: f32) -> Self

Set the progress value (0.0 to 1.0).

Source

pub fn percent(self, percent: u32) -> Self

Set the progress from a percentage (0 to 100).

Source

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

Set the width in characters.

Source

pub fn style(self, style: ProgressStyle) -> Self

Set the progress bar style.

Source

pub fn custom_chars(self, chars: ProgressChars) -> Self

Set custom characters.

Source

pub fn show_percentage(self) -> Self

Show percentage text after the bar.

Source

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

Set a label to show before the bar.

Source

pub fn filled_color(self, color: Color) -> Self

Set the color for the filled portion.

Source

pub fn empty_color(self, color: Color) -> Self

Set the color for the empty portion.

Source

pub fn text_color(self, color: Color) -> Self

Set the color for percentage/label text.

Source

pub fn color(self, color: Color) -> Self

Set a single color for the entire bar.

Source

pub fn brackets(self) -> Self

Show brackets around the bar.

Source

pub fn bold(self) -> Self

Make the filled portion bold.

Source

pub fn dim_empty(self, dim: bool) -> Self

Dim the empty portion.

Source

pub fn bg_color(self, color: Color) -> Self

Set the background color.

Source

pub fn percentage(&self) -> u32

Get the percentage as an integer (0-100).

Source

pub fn render_string(&self) -> String

Build the progress bar string.

Trait Implementations§

Source§

impl Clone for ProgressProps

Source§

fn clone(&self) -> ProgressProps

Returns a duplicate of the value. Read more
1.0.0 · Source§

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

Performs copy-assignment from source. Read more
Source§

impl Debug for ProgressProps

Source§

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

Formats the value using the given formatter. Read more
Source§

impl Default for ProgressProps

Source§

fn default() -> Self

Returns the “default value” for a type. Read more

Auto Trait Implementations§

Blanket Implementations§

Source§

impl<T> Any for T
where T: 'static + ?Sized,

Source§

fn type_id(&self) -> TypeId

Gets the TypeId of self. Read more
Source§

impl<T> Borrow<T> for T
where T: ?Sized,

Source§

fn borrow(&self) -> &T

Immutably borrows from an owned value. Read more
Source§

impl<T> BorrowMut<T> for T
where T: ?Sized,

Source§

fn borrow_mut(&mut self) -> &mut T

Mutably borrows from an owned value. Read more
Source§

impl<T> CloneToUninit for T
where T: Clone,

Source§

unsafe fn clone_to_uninit(&self, dest: *mut u8)

🔬This is a nightly-only experimental API. (clone_to_uninit)
Performs copy-assignment from self to dest. Read more
Source§

impl<T> From<T> for T

Source§

fn from(t: T) -> T

Returns the argument unchanged.

Source§

impl<T, U> Into<U> for T
where U: From<T>,

Source§

fn into(self) -> U

Calls U::from(self).

That is, this conversion is whatever the implementation of From<T> for U chooses to do.

Source§

impl<T> ToOwned for T
where T: Clone,

Source§

type Owned = T

The resulting type after obtaining ownership.
Source§

fn to_owned(&self) -> T

Creates owned data from borrowed data, usually by cloning. Read more
Source§

fn clone_into(&self, target: &mut T)

Uses borrowed data to replace owned data, usually by cloning. Read more
Source§

impl<T, U> TryFrom<U> for T
where U: Into<T>,

Source§

type Error = Infallible

The type returned in the event of a conversion error.
Source§

fn try_from(value: U) -> Result<T, <T as TryFrom<U>>::Error>

Performs the conversion.
Source§

impl<T, U> TryInto<U> for T
where U: TryFrom<T>,

Source§

type Error = <U as TryFrom<T>>::Error

The type returned in the event of a conversion error.
Source§

fn try_into(self) -> Result<U, <U as TryFrom<T>>::Error>

Performs the conversion.