Struct kdam::RichProgress

pub struct RichProgress {
    pub columns: Vec<Column>,
    pub pb: Bar,
}

Available on crate feature rich only.

An implementation rich.progress using Bar.

Example

use kdam::{tqdm, Column, BarExt, RichProgress};

let mut pb = RichProgress::new(
    tqdm!(total = 100),
    vec![Column::Animation, Column::Percentage(2)]
);

for _ in 0..100 {
    pb.update(1).unwrap();
}

eprintln!();

Fields

columns: Vec<Column>

pb: Bar

Implementations

impl RichProgress

pub fn new(pb: Bar, columns: Vec<Column>) -> Self

Create a new RichProgress.

Examples found in repository

examples/rich.rs (lines 8-31)

fn main() -> Result<()> {
    term::init(stderr().is_terminal());
    term::hide_cursor()?;

    let mut pb = RichProgress::new(
        tqdm!(
            total = 231231231,
            unit_scale = true,
            unit_divisor = 1024,
            unit = "B"
        ),
        vec![
            Column::Spinner(Spinner::new(
                &["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"],
                80.0,
                1.0,
            )),
            Column::Text("[bold blue]?".to_owned()),
            Column::Animation,
            Column::Percentage(1),
            Column::Text("•".to_owned()),
            Column::CountTotal,
            Column::Text("•".to_owned()),
            Column::Rate,
            Column::Text("•".to_owned()),
            Column::RemainingTime,
        ],
    );

    pb.write("download will begin in 5 seconds".colorize("bold red"))?;

    while pb.pb.elapsed_time() <= 5.0 {
        pb.refresh()?;
    }

    pb.replace(1, Column::Text("[bold blue]docker.exe".to_owned()));
    pb.write("downloading docker.exe".colorize("bold cyan"))?;

    let total_size = 231231231;
    let mut downloaded = 0;

    while downloaded < total_size {
        let new = std::cmp::min(downloaded + 223211, total_size);
        downloaded = new;
        pb.update_to(new)?;
        std::thread::sleep(std::time::Duration::from_millis(12));
    }

    pb.write("downloaded docker.exe".colorize("bold green"))?;
    eprintln!();

    Ok(())
}

pub fn replace(&mut self, index: usize, col: Column)

Replace a column at specific index.

Panics

If index is out of bounds.

Examples found in repository

examples/rich.rs (line 39)

fn main() -> Result<()> {
    term::init(stderr().is_terminal());
    term::hide_cursor()?;

    let mut pb = RichProgress::new(
        tqdm!(
            total = 231231231,
            unit_scale = true,
            unit_divisor = 1024,
            unit = "B"
        ),
        vec![
            Column::Spinner(Spinner::new(
                &["⠋", "⠙", "⠹", "⠸", "⠼", "⠴", "⠦", "⠧", "⠇", "⠏"],
                80.0,
                1.0,
            )),
            Column::Text("[bold blue]?".to_owned()),
            Column::Animation,
            Column::Percentage(1),
            Column::Text("•".to_owned()),
            Column::CountTotal,
            Column::Text("•".to_owned()),
            Column::Rate,
            Column::Text("•".to_owned()),
            Column::RemainingTime,
        ],
    );

    pb.write("download will begin in 5 seconds".colorize("bold red"))?;

    while pb.pb.elapsed_time() <= 5.0 {
        pb.refresh()?;
    }

    pb.replace(1, Column::Text("[bold blue]docker.exe".to_owned()));
    pb.write("downloading docker.exe".colorize("bold cyan"))?;

    let total_size = 231231231;
    let mut downloaded = 0;

    while downloaded < total_size {
        let new = std::cmp::min(downloaded + 223211, total_size);
        downloaded = new;
        pb.update_to(new)?;
        std::thread::sleep(std::time::Duration::from_millis(12));
    }

    pb.write("downloaded docker.exe".colorize("bold green"))?;
    eprintln!();

    Ok(())
}

pub fn render(&mut self) -> String

Render progress bar text.

Trait Implementations

impl BarExt for RichProgress

fn clear(&mut self) -> Result<()>

Clear current progress bar display.

fn input<T: Into<String>>(&mut self, text: T) -> Result<String>

Take input via progress bar (without overlaping with bar(s)).

fn refresh(&mut self) -> Result<()>

Force refresh current progress bar display.

fn render(&mut self) -> String

Render progress bar text.

fn reset(&mut self, total: Option<usize>)

Resets counter to 0 for repeated use.

fn update(&mut self, n: usize) -> Result<bool>

Manually update the progress bar, useful for streams such as reading files.

fn update_to(&mut self, n: usize) -> Result<bool>

Set counter value instead of incrementing counter through update method.

fn write<T: Into<String>>(&mut self, text: T) -> Result<()>

Print a message via progress bar (without overlaping with bar(s)).

fn write_to<T: Write>( &mut self, writer: &mut T, n: Option<usize> ) -> Result<bool>

Write progress bar rendered text to a writer (useful for writing files).

impl Debug for RichProgress

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

Formats the value using the given formatter.