ui

Documentation

Index

• func NewLogUI(ui cli.Ui) (cli.Ui, error)
• type LogUI
  • func (l *LogUI) Ask(query string) (string, error)
  • func (l *LogUI) AskSecret(query string) (string, error)
  • func (l *LogUI) Error(message string)
  • func (l *LogUI) Info(message string)
  • func (l *LogUI) Output(message string)
  • func (l *LogUI) Warn(message string)

Functions

func NewLogUI

func NewLogUI(ui cli.Ui) (cli.Ui, error)

NewLogUI generates a new cli.Ui that can be used for commands that write log lines to the terminal. The caller is required to pass a cli.BasicUi so we have access to the underlying writers.

Currently, the passed ui needs to be either *cli.ColoredUi or *cli.BasicUi to work correctly. If more are needed, please add them.

Types

type LogUI

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

LogUI is an implementation of the cli.Ui interface which can be used for logging outputs. It differs from cli.BasicUi in the only fact that it does not add a newline after each UI write.

func (*LogUI) Ask

func (l *LogUI) Ask(query string) (string, error)

Ask implements the Ask function of the cli.Ui interface.

func (*LogUI) AskSecret

func (l *LogUI) AskSecret(query string) (string, error)

AskSecret implements the AskSecret function of the cli.Ui interface.

func (*LogUI) Error

func (l *LogUI) Error(message string)

Error implements the Error function of the cli.Ui interface.

func (*LogUI) Info

func (l *LogUI) Info(message string)

Info implements the Info function of the cli.Ui interface.

func (*LogUI) Output

func (l *LogUI) Output(message string)

Output implements the Output function of the cli.Ui interface.

func (*LogUI) Warn

func (l *LogUI) Warn(message string)

Warn implements the Warn function of the cli.Ui interface.