aboutsummaryrefslogtreecommitdiff
path: root/internal/progress/options.go
blob: d7c0889494c3575067f69fa008434a543745b56a (about) (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
package progress

import (
	"io"
	"time"
)

// Options configures one progress meter.
type Options struct {
	Writer io.Writer
	Flush  func() error

	Title string
	Total uint64

	// Delay suppresses progress output until Delay has elapsed since Start.
	Delay time.Duration
	// Sparse forces one final 100% line at Stop when the caller sampled updates.
	Sparse bool
	// Throughput appends ", <total> | <rate>/s" and refreshes rate every 500ms.
	Throughput bool
}