Codebase list golang-github-vbauerster-mpb / 1684b6c
godoc refactoring: width Vladimir Bauer 8 years ago
1 changed file(s) with 9 addition(s) and 9 deletion(s). Raw diff Collapse all Expand all
5353 //
5454 // `fn` DecoratorFunc to wrap
5555 //
56 // `width` width to apply, if `DwidthSync` bit is not set
56 // `width` width reservation to apply, ignored if `DwidthSync` bit is set
5757 //
5858 // `conf` bit set config, [DidentRight|DwidthSync|DextraSpace]
5959 func OnComplete(fn DecoratorFunc, message string, width, conf int) DecoratorFunc {
7070 //
7171 // `name` string to display
7272 //
73 // `width` width to apply, if `DwidthSync` bit is not set
73 // `width` width reservation to apply, ignored if `DwidthSync` bit is set
7474 //
7575 // `conf` bit set config, [DidentRight|DwidthSync|DextraSpace]
7676 func StaticName(name string, width, conf int) DecoratorFunc {
8484 //
8585 // `messageFn` callback function to get dynamic string message
8686 //
87 // `width` width to apply, if `DwidthSync` bit is not set
87 // `width` width reservation to apply, ignored if `DwidthSync` bit is set
8888 //
8989 // `conf` bit set config, [DidentRight|DwidthSync|DextraSpace]
9090 func DynamicName(messageFn func(*Statistics) string, width, conf int) DecoratorFunc {
111111 //
112112 // `pairFormat` printf compatible verbs for current and total, like "%f" or "%d"
113113 //
114 // `width` width to apply, if `DwidthSync` bit is not set
114 // `width` width reservation to apply, ignored if `DwidthSync` bit is set
115115 //
116116 // `conf` bit set config, [DidentRight|DwidthSync|DextraSpace]
117117 func CountersNoUnit(pairFormat string, width, conf int) DecoratorFunc {
122122 //
123123 // `pairFormat` printf compatible verbs for current and total, like "%f" or "%d"
124124 //
125 // `width` width to apply, if `DwidthSync` bit is not set
125 // `width` width reservation to apply, ignored if `DwidthSync` bit is set
126126 //
127127 // `conf` bit set config, [DidentRight|DwidthSync|DextraSpace]
128128 //
137137 //
138138 // `pairFormat` printf compatible verbs for current and total, like "%f" or "%d"
139139 //
140 // `width` width to apply, if `DwidthSync` bit is not set
140 // `width` width reservation to apply, ignored if `DwidthSync` bit is set
141141 //
142142 // `conf` bit set config, [DidentRight|DwidthSync|DextraSpace]
143143 //
178178
179179 // ETA returns exponential-weighted-moving-average ETA decorator.
180180 //
181 // `width` width to apply, if `DwidthSync` bit is not set
181 // `width` width reservation to apply, ignored if `DwidthSync` bit is set
182182 //
183183 // `conf` bit set config, [DidentRight|DwidthSync|DextraSpace]
184184 func ETA(width, conf int) DecoratorFunc {
203203
204204 // Elapsed returns elapsed time decorator.
205205 //
206 // `width` width to apply, if `DwidthSync` bit is not set
206 // `width` width reservation to apply, ignored if `DwidthSync` bit is set
207207 //
208208 // `conf` bit set config, [DidentRight|DwidthSync|DextraSpace]
209209 func Elapsed(width, conf int) DecoratorFunc {
228228
229229 // Percentage returns percentage decorator.
230230 //
231 // `width` width to apply, if `DwidthSync` bit is not set
231 // `width` width reservation to apply, ignored if `DwidthSync` bit is set
232232 //
233233 // `conf` bit set config, [DidentRight|DwidthSync|DextraSpace]
234234 func Percentage(width, conf int) DecoratorFunc {