Struct kdam::Spinner

pub struct Spinner { /* private fields */ }

Available on crate feature spinner only.

Generic spinner for rendering spinner animations.

See more styles at rich repository.

Implementations

impl Spinner

pub fn new(frames: &[&str], interval: f32, speed: f32) -> Self

Create a new Spinner.

Example

use kdam::Spinner;

let spinner = Spinner::new(
    &[
        "▁▂▃", "▂▃▄", "▃▄▅", "▄▅▆", "▅▆▇",
        "▆▇█", "▇█▇", "█▇▆", "▇▆▅", "▆▅▄",
        "▅▄▃", "▄▃▂", "▃▂▁"
    ],
    30.0,
    1.0
);

println!("{}", spinner.render_frame(2.89));

Examples found in repository

examples/showcase/spinner.rs (lines 8-26)

fn main() {
    let spin = Spinner::new(
        &[
            "▁▂▃",
            "▂▃▄",
            "▃▄▅",
            "▄▅▆",
            "▅▆▇",
            "▆▇█",
            "▇█▇",
            "█▇▆",
            "▇▆▅",
            "▆▅▄",
            "▅▄▃",
            "▄▃▂",
            "▃▂▁",
        ],
        30.0,
        1.0,
    );

    let timer = Instant::now();

    loop {
        std::thread::sleep(Duration::from_secs_f32(0.02));
        Writer::Stderr
            .print_at(
                0,
                spin.render_frames(
                    timer.elapsed().as_secs_f32(),
                    NonZeroI16::new((term::width().unwrap_or(30) / 3) as i16).unwrap(),
                )
                .as_bytes(),
            )
            .unwrap();
    }
}

examples/template.rs (lines 10-14)

fn main() -> Result<()> {
    let mut pb = tqdm!(
        total = 300,
        ncols = 40,
        force_refresh = true,
        bar_format = "{desc suffix=' '}|{animation}| {spinner} {count}/{total} [{percentage:.0}%] in {elapsed human=true} ({rate:.1}/s, eta: {remaining human=true})",
        spinner = Spinner::new(
            &["▁▂▃", "▂▃▄", "▃▄▅", "▄▅▆", "▅▆▇", "▆▇█", "▇█▇", "█▇▆", "▇▆▅", "▆▅▄", "▅▄▃", "▄▃▂", "▃▂▁"],
            30.0,
            1.0,
        )
    );

    for _ in 0..300 {
        std::thread::sleep(std::time::Duration::from_secs_f32(0.02));
        pb.update(1)?;
    }

    pb.set_bar_format("{desc suffix=' '}|{animation}| {count}/{total} [{percentage:.0}%] in {elapsed human=true} ({rate:.1}/s)").unwrap();
    pb.clear()?;
    pb.refresh()?;
    eprintln!();

    Ok(())
}

examples/rich.rs (lines 16-20)

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_frame(&self, elapsed_time: f32) -> String

Render a single frame.

pub fn render_frames(&self, elapsed_time: f32, ncols: NonZeroI16) -> String

Render multiple frames upto ncols with an pulsating animation.

Examples found in repository

examples/showcase/spinner.rs (lines 35-38)

fn main() {
    let spin = Spinner::new(
        &[
            "▁▂▃",
            "▂▃▄",
            "▃▄▅",
            "▄▅▆",
            "▅▆▇",
            "▆▇█",
            "▇█▇",
            "█▇▆",
            "▇▆▅",
            "▆▅▄",
            "▅▄▃",
            "▄▃▂",
            "▃▂▁",
        ],
        30.0,
        1.0,
    );

    let timer = Instant::now();

    loop {
        std::thread::sleep(Duration::from_secs_f32(0.02));
        Writer::Stderr
            .print_at(
                0,
                spin.render_frames(
                    timer.elapsed().as_secs_f32(),
                    NonZeroI16::new((term::width().unwrap_or(30) / 3) as i16).unwrap(),
                )
                .as_bytes(),
            )
            .unwrap();
    }
}

Trait Implementations

impl Clone for Spinner

fn clone(&self) -> Spinner

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Spinner

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

Formats the value using the given formatter.