ui

Documentation

Index

• func Fraction(n, d int) string
• type Spinner
  • func (s *Spinner) Start(out io.Writer, prefix string)
  • func (s *Spinner) Stop()
  • func (s *Spinner) Update(progress string)
• type Writer
  • func (w *Writer) Flush(out io.Writer) error
  • func (w *Writer) Write(b []byte) (n int, err error)

Functions

func Fraction

func Fraction(n, d int) string

Fraction is a utility funcation that formats a fraction string, given a numerator and a denominator.

Types

type Spinner

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

Spinner coordinates the formatting of a log line with a spinner at the end.

func (*Spinner) Start

func (s *Spinner) Start(out io.Writer, prefix string)

Start begins the Spinner, which will write all output to the provided Writer. All log lines delivered to the Writer will be prefixed with the specified prefix.

func (*Spinner) Stop

func (s *Spinner) Stop()

Stop closes the Spinner.

func (*Spinner) Update

func (s *Spinner) Update(progress string)

Update passes an updated progress status to the spinner.

type Writer

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

Writer TODO(peter): document

func (*Writer) Flush

func (w *Writer) Flush(out io.Writer) error

Flush TODO(peter): document

func (*Writer) Write

func (w *Writer) Write(b []byte) (n int, err error)