ui

Documentation

Index

• func FormatBytes(c uint64) string
• func FormatDuration(d time.Duration) string
• func FormatPercent(numerator uint64, denominator uint64) string
• func FormatSeconds(sec uint64) string
• func ParseBytes(s string) (int64, error)
• func TerminalDisplayWidth(s string) int
• func ToJSONString(status interface{}) string
• type Message
  • func NewMessage(term Terminal, verbosity uint) *Message
  • func (m *Message) E(msg string, args ...interface{})
  • func (m *Message) P(msg string, args ...interface{})
  • func (m *Message) V(msg string, args ...interface{})
  • func (m *Message) VV(msg string, args ...interface{})
• type MockTerminal
  • func (m *MockTerminal) CanUpdateStatus() bool
  • func (m *MockTerminal) Error(line string)
  • func (m *MockTerminal) Print(line string)
  • func (m *MockTerminal) SetStatus(lines []string)
• type Terminal

Functions

func FormatBytes

func FormatBytes(c uint64) string

func FormatDuration

func FormatDuration(d time.Duration) string

FormatDuration formats d as FormatSeconds would.

func FormatPercent

func FormatPercent(numerator uint64, denominator uint64) string

FormatPercent formats numerator/denominator as a percentage.

func FormatSeconds

func FormatSeconds(sec uint64) string

FormatSeconds formats sec as MM:SS, or HH:MM:SS if sec seconds is at least an hour.

func ParseBytes

func ParseBytes(s string) (int64, error)

ParseBytes parses a size in bytes from s. It understands the suffixes B, K, M, G and T for powers of 1024.

func TerminalDisplayWidth

func TerminalDisplayWidth(s string) int

TerminalDisplayWidth returns the number of terminal cells needed to display s

func ToJSONString

func ToJSONString(status interface{}) string

Types

type Message

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

Message reports progress with messages of different verbosity.

func NewMessage

func NewMessage(term Terminal, verbosity uint) *Message

NewMessage returns a message progress reporter with underlying terminal term.

func (*Message) E

func (m *Message) E(msg string, args ...interface{})

E reports an error

func (*Message) P

func (m *Message) P(msg string, args ...interface{})

P prints a message if verbosity >= 1, this is used for normal messages which are not errors.

func (*Message) V

func (m *Message) V(msg string, args ...interface{})

V prints a message if verbosity >= 2, this is used for verbose messages.

func (*Message) VV

func (m *Message) VV(msg string, args ...interface{})

VV prints a message if verbosity >= 3, this is used for debug messages.

type MockTerminal

type MockTerminal struct {
	Output []string
	Errors []string
}

func (*MockTerminal) CanUpdateStatus

func (m *MockTerminal) CanUpdateStatus() bool

func (*MockTerminal) Error

func (m *MockTerminal) Error(line string)

func (*MockTerminal) Print

func (m *MockTerminal) Print(line string)

func (*MockTerminal) SetStatus

func (m *MockTerminal) SetStatus(lines []string)

type Terminal

type Terminal interface {
	Print(line string)
	Error(line string)
	SetStatus(lines []string)
	CanUpdateStatus() bool
}

Terminal is used to write messages and display status lines which can be updated. See termstatus.Terminal for a concrete implementation.