Enum kdam::Animation

pub enum Animation {
    Arrow,
    Classic,
    Custom(Vec<String>, Option<String>),
    FillUp,
    FiraCode,
    Tqdm,
    TqdmAscii,
}

Animation styles for Bar.

Variants

Arrow

Classic

Custom(Vec<String>, Option<String>)

FillUp

FiraCode

Tqdm

TqdmAscii

Implementations

impl Animation

pub fn custom(charset: &[&str], fill: Option<&str>) -> Self

Create a new Animation::Custom enum variant.

Example

use kdam::Animation;

let custom = Animation::custom(&["\\", "|", "/", "-"], None);
let custom_with_fill = Animation::custom(&["\\", "|", "/", "-"], Some("."));

Examples found in repository

examples/showcase/animations.rs (line 47)

fn main() -> Result<()> {
    term::init(false);
    term::hide_cursor()?;

    let render_length = 300;

    let mut pb1 = tqdm!(
        total = render_length,
        desc = "tqdm    ",
        position = 0,
        force_refresh = true
    );
    let mut pb2 = tqdm!(
        total = render_length,
        desc = "ascii   ",
        animation = "ascii",
        position = 2,
        force_refresh = true
    );
    let mut pb3 = tqdm!(
        total = render_length,
        desc = "fillup  ",
        animation = "fillup",
        position = 4,
        force_refresh = true
    );
    let mut pb4 = tqdm!(
        total = render_length,
        desc = "classic ",
        animation = "classic",
        position = 6,
        force_refresh = true
    );
    let mut pb5 = tqdm!(
        total = render_length,
        desc = "arrow   ",
        animation = "arrow",
        position = 8,
        force_refresh = true
    );
    let mut pb6 = tqdm!(
        total = render_length,
        desc = "custom1 ",
        animation = Animation::custom(&["\\", "|", "/", "-"], None),
        position = 10,
        force_refresh = true
    );
    let mut pb7 = tqdm!(
        total = render_length,
        desc = "custom2 ",
        animation = Animation::custom(&["\\", "|", "/", "-"], Some(".")),
        position = 12,
        force_refresh = true
    );

    println!("animations:\n");

    for _ in 0..render_length {
        pb1.update(1)?;
        pb2.update(1)?;
        pb3.update(1)?;
        pb4.update(1)?;
        pb5.update(1)?;
        pb6.update(1)?;
        pb7.update(1)?;
        std::thread::sleep(std::time::Duration::from_secs_f32(0.02));
    }

    eprint!("{}", "\n".repeat(13));
    Ok(())
}

pub fn render(&self, ncols: NonZeroU16, progress: f32) -> String

Render progress bar animation.

Arguments

• ncols: Number of columns to render.
• progress: Percentage done, it should be in range (0.0 - 1.0) inclusive.

pub fn fmt_render( &self, ncols: NonZeroU16, progress: f32, colour: &Option<Colour> ) -> String

Render progress bar animation with opening and closing brackets.

Examples found in repository

examples/miscellaneous/custom.rs (lines 23-27)

    fn render(&mut self) -> String {
        let fmt_percentage = self.pb.fmt_percentage(0);
        let padding = 1 + fmt_percentage.chars().count() as u16 + self.pb.animation.spaces() as u16;

        let ncols = self.pb.ncols_for_animation(padding);

        if ncols == 0 {
            self.pb.bar_length = padding - 1;
            fmt_percentage
        } else {
            self.pb.bar_length = padding + ncols;
            self.pb.animation.fmt_render(
                NonZeroU16::new(ncols).unwrap(),
                self.pb.percentage(),
                &None,
            ) + " "
                + &fmt_percentage
        }
    }

pub fn spaces(&self) -> u8

Returns extra spaces consumed by fmt_render.

Examples found in repository

examples/miscellaneous/custom.rs (line 14)

    fn render(&mut self) -> String {
        let fmt_percentage = self.pb.fmt_percentage(0);
        let padding = 1 + fmt_percentage.chars().count() as u16 + self.pb.animation.spaces() as u16;

        let ncols = self.pb.ncols_for_animation(padding);

        if ncols == 0 {
            self.pb.bar_length = padding - 1;
            fmt_percentage
        } else {
            self.pb.bar_length = padding + ncols;
            self.pb.animation.fmt_render(
                NonZeroU16::new(ncols).unwrap(),
                self.pb.percentage(),
                &None,
            ) + " "
                + &fmt_percentage
        }
    }

Trait Implementations

impl Clone for Animation

fn clone(&self) -> Animation

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Animation

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

Formats the value using the given formatter.

impl From<&str> for Animation

fn from(animation: &str) -> Self

Converts to this type from the input type.