progressindicator

Documentation

Index

• Variables
• type ProgressIndicator
  • func New() *ProgressIndicator
  • func (pi *ProgressIndicator) IsActive() bool
  • func (pi *ProgressIndicator) SetCharset(charset []string) *ProgressIndicator
  • func (pi *ProgressIndicator) SetColor(color string) *ProgressIndicator
  • func (pi *ProgressIndicator) SetPrefix(text string) *ProgressIndicator
  • func (pi *ProgressIndicator) SetText(text string) *ProgressIndicator
  • func (pi *ProgressIndicator) Start() *ProgressIndicator
  • func (pi *ProgressIndicator) Stop() *ProgressIndicator

Variables

var (
	DefaultRefreshRate = time.Millisecond * 300
	DefaultCharset     = spinner.CharSets[38]
	DefaultColor       = "blue"
)

Types

type ProgressIndicator

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

ProgressIndicator is used to indicator the progress of the running command.

func New

func New() *ProgressIndicator

New creates a new progress indicator.

func (*ProgressIndicator) IsActive

func (pi *ProgressIndicator) IsActive() bool

IsActive returns whether the progress indicator is active or not.

func (*ProgressIndicator) SetCharset

func (pi *ProgressIndicator) SetCharset(charset []string) *ProgressIndicator

SetCharset sets the prefix for progress indicator.

func (*ProgressIndicator) SetColor

func (pi *ProgressIndicator) SetColor(color string) *ProgressIndicator

SetColor sets the prefix for progress indicator.

func (*ProgressIndicator) SetPrefix

func (pi *ProgressIndicator) SetPrefix(text string) *ProgressIndicator

SetPrefix sets the prefix for progress indicator.

func (*ProgressIndicator) SetText

func (pi *ProgressIndicator) SetText(text string) *ProgressIndicator

SetText sets the text for progress indicator.

func (*ProgressIndicator) Start

func (pi *ProgressIndicator) Start() *ProgressIndicator

Start starts the progress indicator.

func (*ProgressIndicator) Stop

func (pi *ProgressIndicator) Stop() *ProgressIndicator

Stop stops the progress indicator.