Commit d98ee948eea9772ab6abac5fe71fb6481182f411 - golang-github-vbauerster-mpb

refactoring: ContainerOption and ContainerOptionOnCondition Vladimir Bauer 7 years ago

5 changed file(s) with 25 addition(s) and 17 deletion(s). Raw diff Collapse all Expand all

-1

_examples/differentWidth/main.go less more

27	27	name := fmt.Sprintf("Bar#%d:", i)
28	28	bar := p.AddBar(int64(total),
29	29	// set BarWidth 40 for bar 1 and 2
30		mpb.OptionOnCondition(mpb.BarWidth(40), func() bool { return i > 0 }),
	30	mpb.BarOptionOnCondition(mpb.BarWidth(40), func() bool { return i > 0 }),
31	31	mpb.PrependDecorators(
32	32	// simple name decorator
33	33	decor.Name(name),

-1

_examples/remove/main.go less more

23	23	for i := 0; i < numBars; i++ {
24	24	name := fmt.Sprintf("Bar#%d:", i)
25	25	b := p.AddBar(int64(total), mpb.BarID(i),
26		mpb.OptionOnCondition(mpb.BarRemoveOnComplete(), func() bool { return i == 0 }),
	26	mpb.BarOptionOnCondition(mpb.BarRemoveOnComplete(), func() bool { return i == 0 }),
27	27	mpb.PrependDecorators(
28	28	decor.Name(name),
29	29	decor.EwmaETA(decor.ET_STYLE_GO, 60, decor.WCSyncSpace),

-2

bar_option.go less more

148	148	}
149	149	}
150	150
151		// OptionOnCondition returns option when condition evaluates to true.
152		func OptionOnCondition(option BarOption, condition func() bool) BarOption {
	151	// BarOptionOnCondition returns option when condition evaluates to true.
	152	func BarOptionOnCondition(option BarOption, condition func() bool) BarOption {
153	153	if condition() {
154	154	return option
155	155	}

+19

-11

options.go less more

8	8	"github.com/vbauerster/mpb/v4/cwriter"
9	9	)
10	10
11		// ProgressOption is a function option which changes the default
12		// behavior of progress pool, if passed to mpb.New(...ProgressOption).
13		type ProgressOption func(*pState)
	11	// ContainerOption is a function option which changes the default
	12	// behavior of progress container, if passed to mpb.New(...ContainerOption).
	13	type ContainerOption func(*pState)
14	14
15	15	// WithWaitGroup provides means to have a single joint point. If
16	16	// *sync.WaitGroup is provided, you can safely call just p.Wait()
17	17	// without calling Wait() on provided *sync.WaitGroup. Makes sense
18	18	// when there are more than one bar to render.
19		func WithWaitGroup(wg *sync.WaitGroup) ProgressOption {
	19	func WithWaitGroup(wg *sync.WaitGroup) ContainerOption {
20	20	return func(s *pState) {
21	21	s.uwg = wg
22	22	}

24	24
25	25	// WithWidth sets container width. Default is 80. Bars inherit this
26	26	// width, as long as no BarWidth is applied.
27		func WithWidth(w int) ProgressOption {
	27	func WithWidth(w int) ContainerOption {
28	28	return func(s *pState) {
29	29	if w >= 0 {
30	30	s.width = w

33	33	}
34	34
35	35	// WithRefreshRate overrides default 120ms refresh rate.
36		func WithRefreshRate(d time.Duration) ProgressOption {
	36	func WithRefreshRate(d time.Duration) ContainerOption {
37	37	return func(s *pState) {
38	38	if d < 10*time.Millisecond {
39	39	return

44	44
45	45	// WithManualRefresh disables internal auto refresh time.Ticker.
46	46	// Refresh will occur upon receive value from provided ch.
47		func WithManualRefresh(ch <-chan time.Time) ProgressOption {
	47	func WithManualRefresh(ch <-chan time.Time) ContainerOption {
48	48	return func(s *pState) {
49	49	s.manualRefreshCh = ch
50	50	}
51	51	}
52	52
53	53	// WithContext provided context will be used for cancellation purposes.
54		func WithContext(ctx context.Context) ProgressOption {
	54	func WithContext(ctx context.Context) ContainerOption {
55	55	return func(s *pState) {
56	56	if ctx == nil {
57	57	return

62	62
63	63	// WithShutdownNotifier provided chanel will be closed, after all bars
64	64	// have been rendered.
65		func WithShutdownNotifier(ch chan struct{}) ProgressOption {
	65	func WithShutdownNotifier(ch chan struct{}) ContainerOption {
66	66	return func(s *pState) {
67	67	s.shutdownNotifier = ch
68	68	}
69	69	}
70	70
71	71	// WithOutput overrides default output os.Stdout.
72		func WithOutput(w io.Writer) ProgressOption {
	72	func WithOutput(w io.Writer) ContainerOption {
73	73	return func(s *pState) {
74	74	if w == nil {
75	75	return

79	79	}
80	80
81	81	// WithDebugOutput sets debug output.
82		func WithDebugOutput(w io.Writer) ProgressOption {
	82	func WithDebugOutput(w io.Writer) ContainerOption {
83	83	return func(s *pState) {
84	84	if w == nil {
85	85	return

87	87	s.debugOut = w
88	88	}
89	89	}
	90
	91	// ContainerOptionOnCondition returns option when condition evaluates to true.
	92	func ContainerOptionOnCondition(option ContainerOption, condition func() bool) ContainerOption {
	93	if condition() {
	94	return option
	95	}
	96	return nil
	97	}

-2

progress.go less more

50	50	}
51	51
52	52	// New creates new Progress instance, which orchestrates bars rendering
53		// process. Accepts mpb.ProgressOption funcs for customization.
54		func New(options ...ProgressOption) *Progress {
	53	// process. Accepts mpb.ContainerOption funcs for customization.
	54	func New(options ...ContainerOption) *Progress {
55	55	pq := make(priorityQueue, 0)
56	56	heap.Init(&pq)
57	57	s := &pState{