spinner

Documentation

Index

• type Spinner
  • func NewSpinner(msgPrefix string) *Spinner
  • func (s *Spinner) Start(ctx context.Context)
  • func (s *Spinner) Update(msg string) error

Types

type Spinner

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

Spinner implements a command line spinner

func NewSpinner

func NewSpinner(msgPrefix string) *Spinner

NewSpinner creates an instance of cmd line spinner Args:

ctx: a system context with cancel, the spinner stops

when context is cancelled

msgPrefix:  a message prefix to be printed on

begining of every line

func (*Spinner) Start

func (s *Spinner) Start(ctx context.Context)

Start should be called as a go routine this func listen for new messages on the spinner channel change the message in the cmd line if a new message is available also responsible for an ascii spinner

func (*Spinner) Update

func (s *Spinner) Update(msg string) error

Update updates the current message that the spinner is printing by default the msg will be an empty string

Args:
	msg: the message to be printed