Crate kdam

Ultimate console progress bar for Rust.

Inspired by tqdm & rich.progress

Quick Insight

• Bar can be used to create progress bars like tqdm.
• RichProgress can be used to create progress bars like rich.progress.

Examples

• One Page Usage
• Project Examples

use kdam::{tqdm, BarExt};

let mut pb = tqdm!(total = 100);

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

eprint!("\n");

Cargo Features

• gradient: Enables gradient colours support for progress bars and printing text.
• spinner: Enables support for using spinners.
• template: Enables templating capabilities for Bar.

Modules

format

Functions for formatting values.

monitor

Monitor mode for progress bars.

term

Terminal related utilities.

Macros

tqdm

tqdm like macro for constructing BarIterator if iterable is given else Bar.

Structs

Bar

Core implemention of console progress bar.

BarBuilder

Create Bar with custom configurations.

BarIterator

Iterable version of Bar.

RichProgress

An implementation rich.progress using Bar.

RowManager

RowManager allows to store and update many progress bars.

Spinnerspinner

Generic spinner for rendering spinner animations. See styles at rich repository.

Enums

Animation

Bar animation styles for Bar.

Column

Renderable columns for RichProgress.

Traits

BarExt

Comman progress bar functionalities shared between different types of progress bars.

TqdmIterator

Rust iterators decoration with BarIterator.