pbars

type BarDrawerFunction func(progress float32, width int) string

type NaiveRateWatcher struct {
	// contains filtered or unexported fields
}

type ProgressPrinter struct {

	// Title is the string printed to the left of the progress bar. It may be blank,
	// and it may contain utf8 characters. It is not included in the width.
	Title string

	// Output is the output writer to print the progress bar to. This is usually os.Stdout,
	// but for tests and certain other cases can be overriden or be nil.
	Output io.Writer

	// Width is the width of the actual bar in the progress bar.
	Width int

	// ShowPercentage sets whether the percentage should be visible on the right hand side.
	ShowPercentage bool

	// ShowRate sets whether the rate in units per second should be visible on the right hand side.
	ShowRate bool

	// ShowTimeEstimate sets whether the estimate of the remaining time should be visible on the right hand side.
	ShowTimeEstimate bool

	// UnitFunc is the formatter applied to the rate value in order to format it to subject-specific units.
	UnitFunc UnitFormatFunc

	// RateWatcher is a model that is used to track the rate, percentage, and time estimates. You probably don't
	// want to change this.
	Ratewatcher RateWatcher

	// Bardrawer is the function used to turn the percentage and width into a progress bar. This can be overriden to
	// pick between utf8 or ascii or to implement your own bar style.
	Bardrawer BarDrawerFunction

	// NonTTY can be used to set the progress bar into a nontty mode when writing output to files. The bar will be printed
	// only once when Done is called, and interrupt messages will function as normal.
	NonTTY bool
	// contains filtered or unexported fields
}

type ProgressReceiver interface {

	// Update performs some work based on the current progres.
	Update(progress, length int64)
}

type RateWatcher interface {
	ProgressReceiver
	fmt.Stringer

	// PercentageComplete should return a float between 0.0 and 1.0
	PercentageComplete() float32

	// HasEstimate
	HasEstimate() bool

	// EstimatedUnitsPerSecond should return a value representing the number of units progressing per second
	EstimatedUnitsPerSecond() float32

	// EstimatedRemaining should return an estimated time remaining
	EstimatedRemaining() time.Duration

	// OverallUnitsPerSecond should return the overall rate seen by the watcher. Pretty much length / elapsed.
	OverallUnitsPerSecond() float32

	// OverallElapsed should return the time since the bar was first seen by the user
	OverallElapsed() time.Duration
}

type UnitFormatFunc func(v float64) string

type UpdateAveragingRateWatcher struct {
	// contains filtered or unexported fields
}