progress

Documentation

Index

• func OutputDeviceIsTerminal() bool
• func SimpleProgress(printChar string, tickInterval time.Duration, action func())
• func SimpleProgressE(printChar string, tickInterval time.Duration, action func() error) error
• type Spinner
  • func NewDefaultSpinner(message string) Spinner
  • func NewDefaultSpinnerWithOutput(message string, output io.Writer) Spinner
  • func NewSpinner(message string, chars []string, delay time.Duration, writer io.Writer) Spinner
  • func (s *Spinner) Start()
  • func (s *Spinner) Stop()
• type Wrapper
  • func NewDefaultWrapper(message string) Wrapper
  • func NewDefaultWrapperWithOutput(message string, output io.Writer) Wrapper
  • func NewWrapper(spinner Spinner, interactiveMode bool) Wrapper
  • func (w Wrapper) WrapAction(action func())

Functions

func OutputDeviceIsTerminal

func OutputDeviceIsTerminal() bool

OutputDeviceIsTerminal ...

func SimpleProgress

func SimpleProgress(printChar string, tickInterval time.Duration, action func())

SimpleProgress ... action : have to be a synchronous action! tickInterval : e.g. : 5000 * time.Millisecond

func SimpleProgressE

func SimpleProgressE(printChar string, tickInterval time.Duration, action func() error) error

SimpleProgressE ...

Types

type Spinner

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

Spinner ...

func NewDefaultSpinner

func NewDefaultSpinner(message string) Spinner

NewDefaultSpinner ...

func NewDefaultSpinnerWithOutput

func NewDefaultSpinnerWithOutput(message string, output io.Writer) Spinner

NewDefaultSpinnerWithOutput ...

func NewSpinner

func NewSpinner(message string, chars []string, delay time.Duration, writer io.Writer) Spinner

NewSpinner ...

func (*Spinner) Start

func (s *Spinner) Start()

Start ...

func (*Spinner) Stop

func (s *Spinner) Stop()

Stop ...

type Wrapper

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

Wrapper ...

func NewDefaultWrapper

func NewDefaultWrapper(message string) Wrapper

NewDefaultWrapper ...

func NewDefaultWrapperWithOutput

func NewDefaultWrapperWithOutput(message string, output io.Writer) Wrapper

NewDefaultWrapperWithOutput ...

func NewWrapper

func NewWrapper(spinner Spinner, interactiveMode bool) Wrapper

NewWrapper ...

func (Wrapper) WrapAction

func (w Wrapper) WrapAction(action func())

WrapAction ...