package mpb
import (
"github.com/vbauerster/mpb/decor"
)
// BarOption is a function option which changes the default behavior of a bar,
// if passed to p.AddBar(int64, ...BarOption)
type BarOption func(*bState)
// AppendDecorators let you inject decorators to the bar's right side
func AppendDecorators(appenders ...decor.DecoratorFunc) BarOption {
return func(s *bState) {
s.aDecorators = append(s.aDecorators, appenders...)
}
}
// PrependDecorators let you inject decorators to the bar's left side
func PrependDecorators(prependers ...decor.DecoratorFunc) BarOption {
return func(s *bState) {
s.pDecorators = append(s.pDecorators, prependers...)
}
}
// BarTrimLeft trims left side space of the bar
func BarTrimLeft() BarOption {
return func(s *bState) {
s.trimLeftSpace = true
}
}
// BarTrimRight trims right space of the bar
func BarTrimRight() BarOption {
return func(s *bState) {
s.trimRightSpace = true
}
}
// BarTrim trims both left and right spaces of the bar
func BarTrim() BarOption {
return func(s *bState) {
s.trimLeftSpace = true
s.trimRightSpace = true
}
}
// BarID overwrites internal bar id
func BarID(id int) BarOption {
return func(s *bState) {
s.id = id
}
}
// BarEtaAlpha option is a way to adjust ETA behavior.
// You can play with it, if you're not satisfied with default behavior.
// Default value is 0.25.
func BarEtaAlpha(a float64) BarOption {
return func(s *bState) {
s.etaAlpha = a
}
}
// BarDynamicTotal enables dynamic total behaviour.
func BarDynamicTotal() BarOption {
return func(s *bState) {
s.dynamic = true
}
}
// BarAutoIncrTotal auto increment total by amount, when trigger percentage remained till bar completion.
// In other words: say you've set trigger = 10, then auto increment will start after bar reaches 90 %.
func BarAutoIncrTotal(trigger, amount int64) BarOption {
return func(s *bState) {
s.dynamic = true
s.totalAutoIncrTrigger = trigger
s.totalAutoIncrBy = amount
}
}
// BarRemoveOnComplete is a flag, which will trigger bar auto remove on completion event.
func BarRemoveOnComplete() BarOption {
return func(s *bState) {
s.removeOnComplete = true
}
}
// BarReplaceOnComplete is indicator for delayed bar start, after the `runningBar` is complete.
// To achieve bar replacement effect, `runningBar` should has its `BarRemoveOnComplete` option set.
func BarReplaceOnComplete(runningBar *Bar) BarOption {
return func(s *bState) {
s.runningBar = runningBar
}
}
// BarClearOnComplete clears the bar section on complete event.
func BarClearOnComplete() BarOption {
return func(s *bState) {
s.noBarOnComplete = true
}
}
// BarPriority sets bar's priority.
// Zero is highest priority, i.e. bar will be on top.
// If `BarReplaceOnComplete` option is supplied, this option is ignored.
func BarPriority(priority int) BarOption {
return func(s *bState) {
s.priority = priority
}
}
func barWidth(w int) BarOption {
return func(s *bState) {
s.width = w
}
}
func barFormat(format string) BarOption {
return func(s *bState) {
s.runes = strToBarRunes(format)
}
}