progress

Documentation

Index

• type PBar
• type PbBuilder
  • func InitializePbBuilder(noProgress, ci, silentFlag bool) *PbBuilder
  • func (i *PbBuilder) BuildCircle(label string) PBar
  • func (i *PbBuilder) BuildCounter(label string, total int, wg *sync.WaitGroup, progressChannel chan int64) PBar

Types

type PBar

type PBar interface {
	Start()
	Close() error
}

PBar is the interface for the types of available progress bars (Circle ,Counter) Start initializes the Progress Bar execution Close stops the Progress Bar execution

type PbBuilder

type PbBuilder struct {
	Silent bool
}

PbBuilder is the struct that contains the progress bar Builders Silent is set to true when all progress bars should be silent

func InitializePbBuilder

func InitializePbBuilder(noProgress, ci, silentFlag bool) *PbBuilder

InitializePbBuilder creates an instace of a PbBuilder

func (*PbBuilder) BuildCircle

func (i *PbBuilder) BuildCircle(label string) PBar

BuildCircle builds and returns a Circle Progress Bar

func (*PbBuilder) BuildCounter

func (i *PbBuilder) BuildCounter(label string, total int, wg *sync.WaitGroup, progressChannel chan int64) PBar

BuildCounter builds and returns a Counter Progress Bar