Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Report ¶ added in v0.2.3
func Report(msg ChannelType)
func Run ¶ added in v0.2.3
func Run() group_waiter.Waitable
Types ¶
type BarClose ¶ added in v0.2.3
func NewBarClose ¶ added in v0.2.3
NewBarClose creates a request to close an existing bar. It is used to prevent the program from being stuck if a progress bar is not completed (due to error). In case the progress bar already completed, it is just ignored.
func NewBarCloseAllowUncompleted ¶ added in v0.2.4
type ChannelType ¶ added in v0.2.3
type ChannelType = interface{}
type MinimumRequiredBars ¶ added in v0.2.3
type MinimumRequiredBars struct {
// contains filtered or unexported fields
}
func NewMinimumRequiredBars ¶ added in v0.2.3
func NewMinimumRequiredBars(count int) MinimumRequiredBars
NewMinimumRequiredBars creates a request to set the minimum number of bars. It is used to prevent the progress bar from finishing before all bars were created.
type OptionalBarCreation ¶ added in v0.2.3
func NewOptionalBar ¶ added in v0.2.3
func NewOptionalBar(name string, total int) OptionalBarCreation
NewOptionalBar creates a request to create a new optional bar. It is used to create a bar without marking it for the minimum requirement count.
type OptionalSpinnerBarCreation ¶ added in v0.2.4
type OptionalSpinnerBarCreation struct {
BarName string
}
func NewOptionalSpinnerBar ¶ added in v0.2.4
func NewOptionalSpinnerBar(name string) OptionalSpinnerBarCreation
type RequiredBarCreation ¶ added in v0.2.3
type RequiredBarCreation OptionalBarCreation
func NewRequiredBar ¶ added in v0.2.3
func NewRequiredBar(name string, total int) RequiredBarCreation
NewRequiredBar creates a request to create a new required bar. It is used to create a bar and mark it for the minimum requirement count.
type SpinnerBarUpdate ¶ added in v0.2.4
type SpinnerBarUpdate struct {
BarUpdate
}
func NewSpinnerBarUpdate ¶ added in v0.2.4
func NewSpinnerBarUpdate(name string, change int) SpinnerBarUpdate
type TimedBarCreation ¶ added in v0.2.3
func NewTimedBar ¶ added in v0.2.3
func NewTimedBar(name string, end time.Time) TimedBarCreation
NewTimedBar creates a request to create a time-based bar. Timed bars are counted with seconds and removed when finished.
Source Files