Skip to content

docs(example): clarify SetTotal usage in dynTotal example #164

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

Merged
vbauerster merged 1 commit into from
Aug 3, 2026
Merged

docs(example): clarify SetTotal usage in dynTotal example #164

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
13 changes: 10 additions & 3 deletions _examples/dynTotal/main.go
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,9 @@ import (
func main() {
p := mpb.New(mpb.WithWidth(64))

// new bar with 'trigger complete event' disabled, because total is zero
// Start with total = 0 because we don't know the final size yet.
// A bar created with total = 0 will NOT auto-complete when current
// reaches total, so we must call SetTotal(final, true) at the end.
bar := p.AddBar(0,
mpb.PrependDecorators(decor.Counters(decor.SizeB1024(0), "% .1f / % .1f")),
mpb.AppendDecorators(decor.Percentage()),
Expand All @@ -27,13 +29,18 @@ func main() {
break
}
written += int64(n)
// following call is not required, it's called to show some progress instead of an empty bar
// SetTotal(written+1024, false) does two things:
// 1. Updates the denominator so Percentage() and Counters show
// meaningful progress instead of "0 / 0".
// 2. The `false` argument means "do NOT trigger completion" —
// we're still streaming and this is just a running estimate.
bar.SetTotal(written+1024, false)
// increment method won't trigger completion because bar was constructed with total = 0
bar.IncrBy(n)
time.Sleep(time.Duration(rand.Intn(10)+1) * maxSleep / 10)
}

// Now that we know the exact total, set it with `true` to trigger
// the completion event and let p.Wait() return.
bar.SetTotal(written, true)

p.Wait()
Expand Down