progressbar

Documentation

Index

• func Report(msg ChannelType)
• func Run() group_waiter.Waitable
• type BarClose
  • func NewBarClose(name string) BarClose
  • func NewBarCloseAllowUncompleted(name string) BarClose
• type BarUpdate
  • func NewUpdate(name string, change int) BarUpdate
• type ChannelType
• type MinimumRequiredBars
  • func NewMinimumRequiredBars(count int) MinimumRequiredBars
• type OptionalBarCreation
  • func NewOptionalBar(name string, total int) OptionalBarCreation
• type OptionalSpinnerBarCreation
  • func NewOptionalSpinnerBar(name string) OptionalSpinnerBarCreation
• type RequiredBarCreation
  • func NewRequiredBar(name string, total int) RequiredBarCreation
• type SpinnerBarUpdate
  • func NewSpinnerBarUpdate(name string, change int) SpinnerBarUpdate
• type TimedBarCreation
  • func NewTimedBar(name string, end time.Time) TimedBarCreation

Functions

func Report

func Report(msg ChannelType)

func Run

func Run() group_waiter.Waitable

Types

type BarClose

type BarClose struct {
	BarName          string
	AllowUncompleted bool
}

func NewBarClose

func NewBarClose(name string) BarClose

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

func NewBarCloseAllowUncompleted(name string) BarClose

type BarUpdate

type BarUpdate struct {
	BarName string
	Change  int
}

func NewUpdate

func NewUpdate(name string, change int) BarUpdate

NewUpdate creates a request to update the count for an existing bar. The change must be positive.

type ChannelType

type ChannelType = interface{}

type MinimumRequiredBars

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

func NewMinimumRequiredBars

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

type OptionalBarCreation struct {
	BarName       string
	TotalEntities int
}

func NewOptionalBar

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

type OptionalSpinnerBarCreation struct {
	BarName string
}

func NewOptionalSpinnerBar

func NewOptionalSpinnerBar(name string) OptionalSpinnerBarCreation

type RequiredBarCreation

type RequiredBarCreation OptionalBarCreation

func NewRequiredBar

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

type SpinnerBarUpdate struct {
	BarUpdate
}

func NewSpinnerBarUpdate

func NewSpinnerBarUpdate(name string, change int) SpinnerBarUpdate

type TimedBarCreation

type TimedBarCreation struct {
	BarName string
	End     time.Time
}

func NewTimedBar

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.