term

Documentation

Index

• Variables
• func ColoredTaskStatus(status baur.TaskStatus) string
• func FormatDuration(d time.Duration, opts ...FormatOption) string
• func FormatSize(bytes uint64, opts ...FormatOption) string
• type FormatOption
  • func FormatBaseWithoutUnitName(enable bool) FormatOption
• type Stream
  • func NewStream(out io.Writer) *Stream
  • func (s *Stream) ErrPrintf(err error, format string, a ...interface{})
  • func (s *Stream) ErrPrintln(err error, msg ...interface{})
  • func (s *Stream) PrintSep()
  • func (s *Stream) Printf(format string, a ...interface{})
  • func (s *Stream) Println(a ...interface{})
  • func (s *Stream) TaskPrintf(task *baur.Task, format string, a ...interface{})
  • func (s *Stream) Write(p []byte) (n int, err error)

Variables

var (
	GreenHighlight  = color.New(color.FgGreen).SprintFunc()
	RedHighlight    = color.New(color.FgRed).SprintFunc()
	YellowHighlight = color.New(color.FgYellow).SprintFunc()

	MagentaHighlight = color.New(color.FgMagenta).SprintFunc()

	Underline = color.New(color.Underline).SprintFunc()

	Highlight = MagentaHighlight
)

Functions

func ColoredTaskStatus

func ColoredTaskStatus(status baur.TaskStatus) string

func FormatDuration

func FormatDuration(d time.Duration, opts ...FormatOption) string

func FormatSize

func FormatSize(bytes uint64, opts ...FormatOption) string

Types

type FormatOption

type FormatOption func(*fmtSettings)

func FormatBaseWithoutUnitName

func FormatBaseWithoutUnitName(enable bool) FormatOption

FormatBaseWithoutUnitName when enabled the Format functions return the value in its base unit without unit-name suffix

type Stream

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

Stream is a concurrency-safe output for term.messages.

func NewStream

func NewStream(out io.Writer) *Stream

func (*Stream) ErrPrintf

func (s *Stream) ErrPrintf(err error, format string, a ...interface{})

ErrPrintf prints an error with an optional printf-style message. The method prints the error in the format: errorPrefix msg: err

func (*Stream) ErrPrintln

func (s *Stream) ErrPrintln(err error, msg ...interface{})

ErrPrintln prints an error with an optional message. The method prints the error in the format: errorPrefix msg: err

func (*Stream) PrintSep

func (s *Stream) PrintSep()

PrintSep prints a separator line

func (*Stream) Printf

func (s *Stream) Printf(format string, a ...interface{})

func (*Stream) Println

func (s *Stream) Println(a ...interface{})

func (*Stream) TaskPrintf

func (s *Stream) TaskPrintf(task *baur.Task, format string, a ...interface{})

TaskPrintf prints a message that is prefixed with '<TASK-NAME>: '

func (*Stream) Write

func (s *Stream) Write(p []byte) (n int, err error)