decor

package
Version: v7.4.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: May 24, 2022 License: Unlicense Imports: 12 Imported by: 58

Documentation

Overview

Package decor provides common decorators for "github.com/vbauerster/mpb/v7" module.

Some decorators returned by this package might have a closure state. It is ok to use decorators concurrently, unless you share the same decorator among multiple *mpb.Bar instances. To avoid data races, create new decorator per *mpb.Bar instance.

Don't:

p := mpb.New()
name := decor.Name("bar")
p.AddBar(100, mpb.AppendDecorators(name))
p.AddBar(100, mpb.AppendDecorators(name))

Do:

p := mpb.New()
p.AddBar(100, mpb.AppendDecorators(decor.Name("bar1")))
p.AddBar(100, mpb.AppendDecorators(decor.Name("bar2")))

Index

Constants

View Source
const (
	UnitKiB
	UnitKB
)
View Source
const (
	// DidentRight bit specifies identation direction.
	// |foo   |b     | With DidentRight
	// |   foo|     b| Without DidentRight
	DidentRight = 1 << iota

	// DextraSpace bit adds extra space, makes sense with DSyncWidth only.
	// When DidentRight bit set, the space will be added to the right,
	// otherwise to the left.
	DextraSpace

	// DSyncWidth bit enables same column width synchronization.
	// Effective with multiple bars only.
	DSyncWidth

	// DSyncWidthR is shortcut for DSyncWidth|DidentRight
	DSyncWidthR = DSyncWidth | DidentRight

	// DSyncSpace is shortcut for DSyncWidth|DextraSpace
	DSyncSpace = DSyncWidth | DextraSpace

	// DSyncSpaceR is shortcut for DSyncWidth|DextraSpace|DidentRight
	DSyncSpaceR = DSyncWidth | DextraSpace | DidentRight
)

Variables

View Source
var (
	WCSyncWidth  = WC{C: DSyncWidth}
	WCSyncWidthR = WC{C: DSyncWidthR}
	WCSyncSpace  = WC{C: DSyncSpace}
	WCSyncSpaceR = WC{C: DSyncSpaceR}
)

Global convenience instances of WC with sync width bit set. To be used with multiple bars only, i.e. not effective for single bar usage.

Functions

func FmtAsSpeed

func FmtAsSpeed(input fmt.Formatter) fmt.Formatter

FmtAsSpeed adds "/s" to the end of the input formatter. To be used with SizeB1000 or SizeB1024 types, for example:

fmt.Printf("%.1f", FmtAsSpeed(SizeB1024(2048)))

func NewMedian

func NewMedian() ewma.MovingAverage

NewMedian is fixed last 3 samples median MovingAverage.

func NewThreadSafeMovingAverage

func NewThreadSafeMovingAverage(average ewma.MovingAverage) ewma.MovingAverage

NewThreadSafeMovingAverage converts provided ewma.MovingAverage into thread safe ewma.MovingAverage.

Types

type AverageDecorator

type AverageDecorator interface {
	AverageAdjust(time.Time)
}

AverageDecorator interface. Average decorators should implement this interface to provide start time adjustment facility, for resume-able tasks.

type Configurator

type Configurator interface {
	GetConf() WC
	SetConf(WC)
}

Configurator interface.

type DecorFunc

type DecorFunc func(Statistics) string

DecorFunc func type. To be used with `func Any`(DecorFunc, ...WC) Decorator`.

type Decorator

type Decorator interface {
	Configurator
	Synchronizer
	Decor(Statistics) string
}

Decorator interface. Most of the time there is no need to implement this interface manually, as decor package already provides a wide range of decorators which implement this interface. If however built-in decorators don't meet your needs, you're free to implement your own one by implementing this particular interface. The easy way to go is to convert a `DecorFunc` into a `Decorator` interface by using provided `func Any(DecorFunc, ...WC) Decorator`.

func Any

func Any(fn DecorFunc, wcc ...WC) Decorator

Any decorator displays text, that can be changed during decorator's lifetime via provided DecorFunc.

`fn` DecorFunc callback

`wcc` optional WC config

func AverageETA

func AverageETA(style TimeStyle, wcc ...WC) Decorator

AverageETA decorator. It's wrapper of NewAverageETA.

`style` one of [ET_STYLE_GO|ET_STYLE_HHMMSS|ET_STYLE_HHMM|ET_STYLE_MMSS]

`wcc` optional WC config

func AverageSpeed

func AverageSpeed(unit int, format string, wcc ...WC) Decorator

AverageSpeed decorator with dynamic unit measure adjustment. It's a wrapper of NewAverageSpeed.

func Counters

func Counters(unit int, pairFmt string, wcc ...WC) Decorator

Counters decorator with dynamic unit measure adjustment.

`unit` one of [0|UnitKiB|UnitKB] zero for no unit

`pairFmt` printf compatible verbs for current and total pair

`wcc` optional WC config

pairFmt example if unit=UnitKB:

pairFmt="%.1f / %.1f"   output: "1.0MB / 12.0MB"
pairFmt="% .1f / % .1f" output: "1.0 MB / 12.0 MB"
pairFmt="%d / %d"       output: "1MB / 12MB"
pairFmt="% d / % d"     output: "1 MB / 12 MB"

func CountersKibiByte

func CountersKibiByte(pairFmt string, wcc ...WC) Decorator

CountersKibiByte is a wrapper around Counters with predefined unit UnitKiB (bytes/1024).

func CountersKiloByte

func CountersKiloByte(pairFmt string, wcc ...WC) Decorator

CountersKiloByte is a wrapper around Counters with predefined unit UnitKB (bytes/1000).

func CountersNoUnit

func CountersNoUnit(pairFmt string, wcc ...WC) Decorator

CountersNoUnit is a wrapper around Counters with no unit param.

func Current

func Current(unit int, format string, wcc ...WC) Decorator

Current decorator with dynamic unit measure adjustment.

`unit` one of [0|UnitKiB|UnitKB] zero for no unit

`format` printf compatible verb for Current

`wcc` optional WC config

format example if unit=UnitKiB:

format="%.1f"  output: "12.0MiB"
format="% .1f" output: "12.0 MiB"
format="%d"    output: "12MiB"
format="% d"   output: "12 MiB"

func CurrentKibiByte

func CurrentKibiByte(format string, wcc ...WC) Decorator

CurrentKibiByte is a wrapper around Current with predefined unit UnitKiB (bytes/1024).

func CurrentKiloByte

func CurrentKiloByte(format string, wcc ...WC) Decorator

CurrentKiloByte is a wrapper around Current with predefined unit UnitKB (bytes/1000).

func CurrentNoUnit

func CurrentNoUnit(format string, wcc ...WC) Decorator

CurrentNoUnit is a wrapper around Current with no unit param.

func Elapsed

func Elapsed(style TimeStyle, wcc ...WC) Decorator

Elapsed decorator. It's wrapper of NewElapsed.

`style` one of [ET_STYLE_GO|ET_STYLE_HHMMSS|ET_STYLE_HHMM|ET_STYLE_MMSS]

`wcc` optional WC config

func EwmaETA

func EwmaETA(style TimeStyle, age float64, wcc ...WC) Decorator

EwmaETA exponential-weighted-moving-average based ETA decorator. For this decorator to work correctly you have to measure each iteration's duration and pass it to the *Bar.DecoratorEwmaUpdate(time.Duration) method after each increment.

func EwmaSpeed

func EwmaSpeed(unit int, format string, age float64, wcc ...WC) Decorator

EwmaSpeed exponential-weighted-moving-average based speed decorator. For this decorator to work correctly you have to measure each iteration's duration and pass it to the *Bar.DecoratorEwmaUpdate(time.Duration) method after each increment.

func InvertedCurrent

func InvertedCurrent(unit int, format string, wcc ...WC) Decorator

InvertedCurrent decorator with dynamic unit measure adjustment.

`unit` one of [0|UnitKiB|UnitKB] zero for no unit

`format` printf compatible verb for InvertedCurrent

`wcc` optional WC config

format example if unit=UnitKiB:

format="%.1f"  output: "12.0MiB"
format="% .1f" output: "12.0 MiB"
format="%d"    output: "12MiB"
format="% d"   output: "12 MiB"

func InvertedCurrentKibiByte

func InvertedCurrentKibiByte(format string, wcc ...WC) Decorator

InvertedCurrentKibiByte is a wrapper around InvertedCurrent with predefined unit UnitKiB (bytes/1024).

func InvertedCurrentKiloByte

func InvertedCurrentKiloByte(format string, wcc ...WC) Decorator

InvertedCurrentKiloByte is a wrapper around InvertedCurrent with predefined unit UnitKB (bytes/1000).

func InvertedCurrentNoUnit

func InvertedCurrentNoUnit(format string, wcc ...WC) Decorator

InvertedCurrentNoUnit is a wrapper around InvertedCurrent with no unit param.

func Merge

func Merge(decorator Decorator, placeholders ...WC) Decorator

Merge wraps its decorator argument with intention to sync width with several decorators of another bar. Visual example:

+----+--------+---------+--------+
| B1 |      MERGE(D, P1, Pn)     |
+----+--------+---------+--------+
| B2 |   D0   |   D1    |   Dn   |
+----+--------+---------+--------+

func MovingAverageETA

func MovingAverageETA(style TimeStyle, average ewma.MovingAverage, normalizer TimeNormalizer, wcc ...WC) Decorator

MovingAverageETA decorator relies on MovingAverage implementation to calculate its average.

`style` one of [ET_STYLE_GO|ET_STYLE_HHMMSS|ET_STYLE_HHMM|ET_STYLE_MMSS]

`average` implementation of MovingAverage interface

`normalizer` available implementations are [FixedIntervalTimeNormalizer|MaxTolerateTimeNormalizer]

`wcc` optional WC config

func MovingAverageSpeed

func MovingAverageSpeed(unit int, format string, average ewma.MovingAverage, wcc ...WC) Decorator

MovingAverageSpeed decorator relies on MovingAverage implementation to calculate its average.

`unit` one of [0|UnitKiB|UnitKB] zero for no unit

`format` printf compatible verb for value, like "%f" or "%d"

`average` MovingAverage implementation

`wcc` optional WC config

format examples:

unit=UnitKiB, format="%.1f"  output: "1.0MiB/s"
unit=UnitKiB, format="% .1f" output: "1.0 MiB/s"
unit=UnitKB,  format="%.1f"  output: "1.0MB/s"
unit=UnitKB,  format="% .1f" output: "1.0 MB/s"

func Name

func Name(str string, wcc ...WC) Decorator

Name decorator displays text that is set once and can't be changed during decorator's lifetime.

`str` string to display

`wcc` optional WC config

func NewAverageETA

func NewAverageETA(style TimeStyle, startTime time.Time, normalizer TimeNormalizer, wcc ...WC) Decorator

NewAverageETA decorator with user provided start time.

`style` one of [ET_STYLE_GO|ET_STYLE_HHMMSS|ET_STYLE_HHMM|ET_STYLE_MMSS]

`startTime` start time

`normalizer` available implementations are [FixedIntervalTimeNormalizer|MaxTolerateTimeNormalizer]

`wcc` optional WC config

func NewAverageSpeed

func NewAverageSpeed(unit int, format string, startTime time.Time, wcc ...WC) Decorator

NewAverageSpeed decorator with dynamic unit measure adjustment and user provided start time.

`unit` one of [0|UnitKiB|UnitKB] zero for no unit

`format` printf compatible verb for value, like "%f" or "%d"

`startTime` start time

`wcc` optional WC config

format examples:

unit=UnitKiB, format="%.1f"  output: "1.0MiB/s"
unit=UnitKiB, format="% .1f" output: "1.0 MiB/s"
unit=UnitKB,  format="%.1f"  output: "1.0MB/s"
unit=UnitKB,  format="% .1f" output: "1.0 MB/s"

func NewElapsed

func NewElapsed(style TimeStyle, startTime time.Time, wcc ...WC) Decorator

NewElapsed returns elapsed time decorator.

`style` one of [ET_STYLE_GO|ET_STYLE_HHMMSS|ET_STYLE_HHMM|ET_STYLE_MMSS]

`startTime` start time

`wcc` optional WC config

func NewPercentage

func NewPercentage(format string, wcc ...WC) Decorator

NewPercentage percentage decorator with custom format string.

format examples:

format="%.1f"  output: "1.0%"
format="% .1f" output: "1.0 %"
format="%d"    output: "1%"
format="% d"   output: "1 %"

func OnAbort added in v7.2.0

func OnAbort(decorator Decorator, message string) Decorator

OnAbort returns decorator, which wraps provided decorator with sole purpose to display provided message on abort event. It has no effect if bar.Abort(drop bool) is called with true argument.

`decorator` Decorator to wrap

`message` message to display on abort event

func OnComplete

func OnComplete(decorator Decorator, message string) Decorator

OnComplete returns decorator, which wraps provided decorator with sole purpose to display provided message on complete event.

`decorator` Decorator to wrap

`message` message to display on complete event

func OnCondition added in v7.3.0

func OnCondition(decorator Decorator, cond bool) Decorator

OnCondition returns decorator if condition is true.

`decorator` Decorator

`cond` bool

func OnPredicate added in v7.3.0

func OnPredicate(decorator Decorator, predicate func() bool) Decorator

OnPredicate returns decorator if predicate evaluates to true.

`decorator` Decorator

`predicate` func() bool

func Percentage

func Percentage(wcc ...WC) Decorator

Percentage returns percentage decorator. It's a wrapper of NewPercentage.

func Spinner

func Spinner(frames []string, wcc ...WC) Decorator

Spinner returns spinner decorator.

`frames` spinner frames, if nil or len==0, default is used

`wcc` optional WC config

func Total

func Total(unit int, format string, wcc ...WC) Decorator

Total decorator with dynamic unit measure adjustment.

`unit` one of [0|UnitKiB|UnitKB] zero for no unit

`format` printf compatible verb for Total

`wcc` optional WC config

format example if unit=UnitKiB:

format="%.1f"  output: "12.0MiB"
format="% .1f" output: "12.0 MiB"
format="%d"    output: "12MiB"
format="% d"   output: "12 MiB"

func TotalKibiByte

func TotalKibiByte(format string, wcc ...WC) Decorator

TotalKibiByte is a wrapper around Total with predefined unit UnitKiB (bytes/1024).

func TotalKiloByte

func TotalKiloByte(format string, wcc ...WC) Decorator

TotalKiloByte is a wrapper around Total with predefined unit UnitKB (bytes/1000).

func TotalNoUnit

func TotalNoUnit(format string, wcc ...WC) Decorator

TotalNoUnit is a wrapper around Total with no unit param.

type EwmaDecorator

type EwmaDecorator interface {
	EwmaUpdate(int64, time.Duration)
}

EwmaDecorator interface. EWMA based decorators should implement this one.

type ShutdownListener

type ShutdownListener interface {
	Shutdown()
}

ShutdownListener interface. If decorator needs to be notified once upon bar shutdown event, so this is the right interface to implement.

type SizeB1000

type SizeB1000 int64

SizeB1000 named type, which implements fmt.Formatter interface. It adjusts its value according to byte size multiple by 1000 and appends appropriate size marker (KB, MB, GB, TB).

func (SizeB1000) Format

func (self SizeB1000) Format(st fmt.State, verb rune)

func (SizeB1000) String

func (i SizeB1000) String() string

type SizeB1024

type SizeB1024 int64

SizeB1024 named type, which implements fmt.Formatter interface. It adjusts its value according to byte size multiple by 1024 and appends appropriate size marker (KiB, MiB, GiB, TiB).

func (SizeB1024) Format

func (self SizeB1024) Format(st fmt.State, verb rune)

func (SizeB1024) String

func (i SizeB1024) String() string

type Statistics

type Statistics struct {
	AvailableWidth int
	ID             int
	Total          int64
	Current        int64
	Refill         int64
	Completed      bool
	Aborted        bool
}

Statistics consists of progress related statistics, that Decorator may need.

type Synchronizer

type Synchronizer interface {
	Sync() (chan int, bool)
}

Synchronizer interface. All decorators implement this interface implicitly. Its Sync method exposes width sync channel, if DSyncWidth bit is set.

type TimeNormalizer

type TimeNormalizer interface {
	Normalize(time.Duration) time.Duration
}

TimeNormalizer interface. Implementors could be passed into MovingAverageETA, in order to affect i.e. normalize its output.

func FixedIntervalTimeNormalizer

func FixedIntervalTimeNormalizer(updInterval int) TimeNormalizer

FixedIntervalTimeNormalizer returns implementation of TimeNormalizer.

func MaxTolerateTimeNormalizer

func MaxTolerateTimeNormalizer(maxTolerate time.Duration) TimeNormalizer

MaxTolerateTimeNormalizer returns implementation of TimeNormalizer.

type TimeNormalizerFunc

type TimeNormalizerFunc func(time.Duration) time.Duration

TimeNormalizerFunc is function type adapter to convert function into TimeNormalizer.

func (TimeNormalizerFunc) Normalize

func (f TimeNormalizerFunc) Normalize(src time.Duration) time.Duration

type TimeStyle

type TimeStyle int

TimeStyle enum.

const (
	ET_STYLE_GO TimeStyle = iota
	ET_STYLE_HHMMSS
	ET_STYLE_HHMM
	ET_STYLE_MMSS
)

TimeStyle kinds.

type WC

type WC struct {
	W int
	C int
	// contains filtered or unexported fields
}

WC is a struct with two public fields W and C, both of int type. W represents width and C represents bit set of width related config. A decorator should embed WC, to enable width synchronization.

func (*WC) FormatMsg

func (wc *WC) FormatMsg(msg string) string

FormatMsg formats final message according to WC.W and WC.C. Should be called by any Decorator implementation.

func (*WC) GetConf

func (wc *WC) GetConf() WC

GetConf is implementation of Configurator interface.

func (*WC) Init

func (wc *WC) Init() WC

Init initializes width related config.

func (*WC) SetConf

func (wc *WC) SetConf(conf WC)

SetConf is implementation of Configurator interface.

func (*WC) Sync

func (wc *WC) Sync() (chan int, bool)

Sync is implementation of Synchronizer interface.

type Wrapper

type Wrapper interface {
	Base() Decorator
}

Wrapper interface. If you're implementing custom Decorator by wrapping a built-in one, it is necessary to implement this interface to retain functionality of built-in Decorator.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL