Skip to content

Add MultiBar for safe deferred progress bar configuration #787

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
jgrund wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Add MultiBar for safe deferred progress bar configuration #787

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cdcb191
Add MultiBar type for safe deferred progress bar configuration
jgrund Apr 3, 2026
9d90838
Rename MultiBar to ProgressBarBuilder, deprecate MultiProgress::add
jgrund Apr 8, 2026
330ea31
Fix rustdoc link to private ProgressStyle::set_for_stderr
jgrund Apr 9, 2026
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 12 additions & 7 deletions examples/finebars.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
use std::thread;
use std::time::Duration;

use indicatif::{MultiProgress, ProgressBar, ProgressStyle};
use indicatif::{MultiProgress, ProgressBarBuilder, ProgressStyle};
use rand::RngExt;

fn main() {
Expand All @@ -18,13 +18,18 @@ fn main() {
let handles: Vec<_> = styles
.iter()
.map(|s| {
let pb = m.add(ProgressBar::new(512));
pb.set_style(
ProgressStyle::with_template(&format!("{{prefix:.bold}}▕{{bar:.{}}}▏{{msg}}", s.2))
.unwrap()
.progress_chars(s.1),
let pb = m.register(
ProgressBarBuilder::new(512)
.with_style(
ProgressStyle::with_template(&format!(
"{{prefix:.bold}}▕{{bar:.{}}}▏{{msg}}",
s.2
))
.unwrap()
.progress_chars(s.1),
)
.with_prefix(s.0),
);
pb.set_prefix(s.0);
let wait = Duration::from_millis(rand::rng().random_range(10..30));
thread::spawn(move || {
for i in 0..512 {
Expand Down
8 changes: 3 additions & 5 deletions examples/morebars.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -2,21 +2,19 @@ use std::sync::Arc;
use std::thread;
use std::time::Duration;

use indicatif::{MultiProgress, ProgressBar, ProgressStyle};
use indicatif::{MultiProgress, ProgressBarBuilder, ProgressStyle};

fn main() {
let m = Arc::new(MultiProgress::new());
let sty = ProgressStyle::with_template("{bar:40.green/yellow} {pos:>7}/{len:7}").unwrap();

let pb = m.add(ProgressBar::new(5));
pb.set_style(sty.clone());
let pb = m.register(ProgressBarBuilder::new(5).with_style(sty.clone()));

// make sure we show up at all. otherwise no rendering
// event.
pb.tick();
for _ in 0..5 {
let pb2 = m.add(ProgressBar::new(128));
pb2.set_style(sty.clone());
let pb2 = m.register(ProgressBarBuilder::new(128).with_style(sty.clone()));
for _ in 0..128 {
thread::sleep(Duration::from_millis(5));
pb2.inc(1);
Expand Down
95 changes: 36 additions & 59 deletions examples/multi-tree-ext.rs
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,9 @@ use std::thread;
use std::time::Duration;

use console::style;
use indicatif::{MultiProgress, MultiProgressAlignment, ProgressBar, ProgressStyle};
use indicatif::{
MultiProgress, MultiProgressAlignment, ProgressBar, ProgressBarBuilder, ProgressStyle,
};
use once_cell::sync::Lazy;
use rand::rngs::ThreadRng;
use rand::{Rng, RngExt};
Expand All @@ -29,7 +31,6 @@ struct Item {
key: String,
index: usize,
indent: usize,
progress_bar: ProgressBar,
}

#[derive(Clone, Debug)]
Expand All @@ -43,55 +44,46 @@ static ELEMENTS: Lazy<[Elem; 27]> = Lazy::new(|| {
Elem::AddItem(Item {
indent: 9,
index: 0,
progress_bar: ProgressBar::new(PB_LEN),
key: "dog".to_string(),
}),
Elem::AddItem(Item {
indent: 0,
index: 0,
progress_bar: ProgressBar::new(PB_LEN),
key: "temp_1".to_string(),
}),
Elem::AddItem(Item {
indent: 8,
index: 1,
progress_bar: ProgressBar::new(PB_LEN),
key: "lazy".to_string(),
}),
Elem::AddItem(Item {
indent: 0,
index: 1,
progress_bar: ProgressBar::new(PB_LEN),
key: "temp_2".to_string(),
}),
Elem::AddItem(Item {
indent: 1,
index: 0,
progress_bar: ProgressBar::new(PB_LEN),
key: "the".to_string(),
}),
Elem::AddItem(Item {
indent: 0,
index: 0,
progress_bar: ProgressBar::new(PB_LEN),
key: "temp_3".to_string(),
}),
Elem::AddItem(Item {
indent: 7,
index: 3,
progress_bar: ProgressBar::new(PB_LEN),
key: "a".to_string(),
}),
Elem::AddItem(Item {
indent: 0,
index: 3,
progress_bar: ProgressBar::new(PB_LEN),
key: "temp_4".to_string(),
}),
Elem::AddItem(Item {
indent: 6,
index: 2,
progress_bar: ProgressBar::new(PB_LEN),
key: "over".to_string(),
}),
Elem::RemoveItem(Index(6)),
Expand All @@ -101,55 +93,46 @@ static ELEMENTS: Lazy<[Elem; 27]> = Lazy::new(|| {
Elem::AddItem(Item {
indent: 0,
index: 2,
progress_bar: ProgressBar::new(PB_LEN),
key: "temp_5".to_string(),
}),
Elem::AddItem(Item {
indent: 4,
index: 1,
progress_bar: ProgressBar::new(PB_LEN),
key: "fox".to_string(),
}),
Elem::AddItem(Item {
indent: 0,
index: 1,
progress_bar: ProgressBar::new(PB_LEN),
key: "temp_6".to_string(),
}),
Elem::AddItem(Item {
indent: 2,
index: 1,
progress_bar: ProgressBar::new(PB_LEN),
key: "quick".to_string(),
}),
Elem::AddItem(Item {
indent: 0,
index: 1,
progress_bar: ProgressBar::new(PB_LEN),
key: "temp_7".to_string(),
}),
Elem::AddItem(Item {
indent: 5,
index: 5,
progress_bar: ProgressBar::new(PB_LEN),
key: "jumps".to_string(),
}),
Elem::AddItem(Item {
indent: 0,
index: 5,
progress_bar: ProgressBar::new(PB_LEN),
key: "temp_8".to_string(),
}),
Elem::AddItem(Item {
indent: 3,
index: 4,
progress_bar: ProgressBar::new(PB_LEN),
key: "brown".to_string(),
}),
Elem::AddItem(Item {
indent: 0,
index: 3,
progress_bar: ProgressBar::new(PB_LEN),
key: "temp_9".to_string(),
}),
Elem::RemoveItem(Index(10)),
Expand Down Expand Up @@ -190,25 +173,20 @@ pub fn main() {
ProgressStyle::with_template("[{pos:>2}/{len:2}] {prefix}{spinner:.green} {msg}").unwrap();
let sty_fin = ProgressStyle::with_template("[{pos:>2}/{len:2}] {prefix}{msg}").unwrap();

let pb_main = mp.add(ProgressBar::new(
ELEMENTS
.iter()
.map(|e| match e {
Elem::AddItem(item) => item.progress_bar.length().unwrap(),
Elem::RemoveItem(_) => 1,
})
.sum(),
));
let pb_main = mp.register(
ProgressBarBuilder::new(
ELEMENTS
.iter()
.map(|e| match e {
Elem::AddItem(_) => PB_LEN,
Elem::RemoveItem(_) => 1,
})
.sum(),
)
.with_style(sty_main),
);

pb_main.set_style(sty_main);
for e in ELEMENTS.iter() {
match e {
Elem::AddItem(item) => item.progress_bar.set_style(sty_aux.clone()),
Elem::RemoveItem(_) => {}
}
}

let mut items: Vec<&Item> = Vec::with_capacity(ELEMENTS.len());
let mut items: Vec<(&Item, ProgressBar)> = Vec::with_capacity(ELEMENTS.len());

let mp2 = Arc::clone(&mp);
let mut rng = ThreadRng::default();
Expand All @@ -222,29 +200,28 @@ pub fn main() {
}
Action::ModifyTree(elem_idx) => match &ELEMENTS[elem_idx] {
Elem::AddItem(item) => {
let pb = mp2.insert(item.index, item.progress_bar.clone());
pb.set_prefix(" ".repeat(item.indent));
pb.set_message(&item.key);
items.insert(item.index, item);
let pb = mp2.register_at(
item.index,
ProgressBarBuilder::new(PB_LEN)
.with_style(sty_aux.clone())
.with_prefix(" ".repeat(item.indent))
.with_message(item.key.clone()),
);
items.insert(item.index, (item, pb));
}
Elem::RemoveItem(Index(index)) => {
let item = items.remove(*index);
let pb = &item.progress_bar;
mp2.remove(pb);
let (_, pb) = items.remove(*index);
mp2.remove(&pb);
pb_main.inc(pb.length().unwrap() - pb.position());
}
},
Action::IncProgressBar(item_idx) => {
let item = &items[item_idx];
item.progress_bar.inc(1);
let pos = item.progress_bar.position();
if pos >= item.progress_bar.length().unwrap() {
item.progress_bar.set_style(sty_fin.clone());
item.progress_bar.finish_with_message(format!(
"{} {}",
style("✔").green(),
item.key
));
let (item, pb) = &items[item_idx];
pb.inc(1);
let pos = pb.position();
if pos >= pb.length().unwrap() {
pb.set_style(sty_fin.clone());
pb.finish_with_message(format!("{} {}", style("✔").green(), item.key));
}
pb_main.inc(1);
}
Expand All @@ -254,15 +231,15 @@ pub fn main() {
}

/// The function guarantees to return the action, that is valid for the current tree.
fn get_action(rng: &mut dyn Rng, items: &[&Item]) -> Action {
fn get_action(rng: &mut dyn Rng, items: &[(&Item, ProgressBar)]) -> Action {
let elem_idx = ELEM_IDX.load(Ordering::SeqCst);
// the indices of those items, that not completed yet
let uncompleted = items
.iter()
.enumerate()
.filter(|(_, item)| {
let pos = item.progress_bar.position();
pos < item.progress_bar.length().unwrap()
.filter(|(_, (_, pb))| {
let pos = pb.position();
pos < pb.length().unwrap()
})
.map(|(idx, _)| idx)
.collect::<Vec<usize>>();
Expand Down
Loading
Loading