ui

Documentation

Index

• func Template(destination io.Writer, name, text string, data interface{}) error
• type Level
  • func (levelA Level) OutputIsIncluded(levelB Level) bool
• type UI
  • func Create(out, err io.Writer) *UI
  • func (ui *UI) EmphasizeInfoln(format string, args ...interface{})
  • func (ui *UI) Errorln(format string, args ...interface{})
  • func (ui *UI) Infoln(format string, args ...interface{})
  • func (ui *UI) Output(format string, args ...interface{})
  • func (ui *UI) SetContext(level Level) *UI
  • func (ui *UI) SetUserLevel(level Level) *UI
  • func (ui *UI) Titleln(format string, args ...interface{})
  • func (ui *UI) Verboseln(format string, args ...interface{})

Functions

func Template

func Template(destination io.Writer, name, text string, data interface{}) error

Types

type Level

type Level string

Level specifies the level of output that commands should print

const (
	LevelVerbose Level = "Verbose"
	LevelInfo    Level = "Info"
	LevelError   Level = "Error"
	LevelSilent  Level = "Silent"
)

LevelVerbose includes all output

func (Level) OutputIsIncluded

func (levelA Level) OutputIsIncluded(levelB Level) bool

OutputIsIncluded returns true if levelA specifies that levelB should be included for output

type UI

type UI struct {
	EffectiveLevel Level
	DefaultLevel   Level
	UserLevel      Level
	UserLevelSet   bool
	Out            io.Writer
	Err            io.Writer
}

UI is the abstraction of handling terminal output for shuttle

func Create

func Create(out, err io.Writer) *UI

Create doc

func (*UI) EmphasizeInfoln

func (ui *UI) EmphasizeInfoln(format string, args ...interface{})

func (*UI) Errorln

func (ui *UI) Errorln(format string, args ...interface{})

Errorln doc

func (*UI) Infoln

func (ui *UI) Infoln(format string, args ...interface{})

Infoln prints a formatted info message line.

func (*UI) Output

func (ui *UI) Output(format string, args ...interface{})

Output.

func (*UI) SetContext

func (ui *UI) SetContext(level Level) *UI

SetContext doc

func (*UI) SetUserLevel

func (ui *UI) SetUserLevel(level Level) *UI

SetUserLevel doc

func (*UI) Titleln

func (ui *UI) Titleln(format string, args ...interface{})

Titleln doc

func (*UI) Verboseln

func (ui *UI) Verboseln(format string, args ...interface{})

Verboseln prints a formatted verbose message line.