ea_indicator

Documentation

Index

• func StartIndicator()
• func SuppressIndicator()
• func SuppressIndicatorForce()
• type Container
  • func Global() Container
• type Indicator
  • func NewNopIndicator() Indicator
• type Status
• type StatusBar
  • func NewNopStatus() StatusBar
• type StatusListener

Functions

func StartIndicator

func StartIndicator()

func SuppressIndicator

func SuppressIndicator()

func SuppressIndicatorForce

func SuppressIndicatorForce()

Types

type Container

type Container interface {
	// Add new indicator
	NewIndicator(total int64, opts ...mpb.BarOption) Indicator

	// Add new status
	NewStatus(name string, opts ...mpb.BarOption) StatusBar

	// Mark all indicators as done, and wait for shutdown
	Done()
}

func Global

func Global() Container

type Indicator

type Indicator interface {
	AddTotal(total int64)
	AddProgress(progress int64)
	UpdateProgress(progress int64)
	UpdateTotal(total int64)
	Done()
}

func NewNopIndicator

func NewNopIndicator() Indicator

type Status

type Status interface {
	UpdateTitle(title string)
	UpdateStatus(status string)
	CurrentTitle() string
	CurrentStatus() string
	SetListener(listener StatusListener)
}

type StatusBar

type StatusBar interface {
	Status
	StatusListener
	Done()
}

Status bar

func NewNopStatus

func NewNopStatus() StatusBar

type StatusListener

type StatusListener interface {
	Update()
}