output

Documentation

Index

• type Output
  • func NewStdout() Output
• type Report
• type Stdout
  • func (s *Stdout) Alert(str string)
  • func (s *Stdout) Alertf(format string, a ...interface{})
  • func (s *Stdout) Error(err error)
  • func (s *Stdout) HideLoader()
  • func (s *Stdout) HidePercentage()
  • func (s *Stdout) HideXonY()
  • func (s *Stdout) Info(str string)
  • func (s *Stdout) Infof(format string, a ...interface{})
  • func (s *Stdout) InstructionTitle(str string)
  • func (s *Stdout) Report()
  • func (s *Stdout) ShowLoader()
  • func (s *Stdout) ShowPercentage(p int)
  • func (s *Stdout) ShowXonY(x, y int)
  • func (s *Stdout) StepTitle(str string)
  • func (s *Stdout) Success(str string)
  • func (s *Stdout) Successf(format string, a ...interface{})

Types

type Output

type Output interface {
	StepTitle(string)                         // StepTitle writes a step title
	InstructionTitle(string)                  // InstructionTitle writes an instruction title
	Info(string)                              // Info writes an informational message
	Infof(format string, a ...interface{})    // Infof writes an informational message with formatting
	Success(string)                           // Success writes a successful message
	Successf(format string, a ...interface{}) // Success writes a successful message with formatting
	Alert(string)                             // Alert writes an alert message
	Alertf(format string, a ...interface{})   // Alertf writes an alert message with formatting
	Error(error)                              // Error writes an error message

	ShowLoader() // ShowLoader displays the loader
	HideLoader() // HideLoader hides the loader

	ShowPercentage(int) // ShowPercentage displays the loader with percentage
	HidePercentage()    // HidePercentage hides the loader with percentage

	ShowXonY(int, int) // ShowXonY displays the loader with "X/Y" information
	HideXonY()         // HideXonY hides the loader with "X/Y" information

	Report() // Report writes the summary
}

Output is an output for quickonf

func NewStdout

func NewStdout() Output

NewStdout returns a new output writer which writes on stdout

type Report

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

Report gathers data for reporting

type Stdout

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

Stdout is an output writer which writes on stdout

func (*Stdout) Alert

func (s *Stdout) Alert(str string)

Alert writes an alert message

func (*Stdout) Alertf

func (s *Stdout) Alertf(format string, a ...interface{})

Alertf writes an alert message with formatting

func (*Stdout) Error

func (s *Stdout) Error(err error)

Error writes an error message

func (*Stdout) HideLoader

func (s *Stdout) HideLoader()

HideLoader hides the loader

func (*Stdout) HidePercentage

func (s *Stdout) HidePercentage()

HidePercentage hides the loader with percentage

func (*Stdout) HideXonY

func (s *Stdout) HideXonY()

HideXonY hides the loader with "X/Y" information

func (*Stdout) Info

func (s *Stdout) Info(str string)

Info writes an informational message

func (*Stdout) Infof

func (s *Stdout) Infof(format string, a ...interface{})

Infof writes an informational message with format

func (*Stdout) InstructionTitle

func (s *Stdout) InstructionTitle(str string)

InstructionTitle writes an instruction title

func (*Stdout) Report

func (s *Stdout) Report()

Report writes the summary

func (*Stdout) ShowLoader

func (s *Stdout) ShowLoader()

ShowLoader displays the loader

func (*Stdout) ShowPercentage

func (s *Stdout) ShowPercentage(p int)

ShowPercentage displays the loader with percentage

func (*Stdout) ShowXonY

func (s *Stdout) ShowXonY(x, y int)

ShowXonY displays the loader with "X/Y" information

func (*Stdout) StepTitle

func (s *Stdout) StepTitle(str string)

StepTitle writes a step title

func (*Stdout) Success

func (s *Stdout) Success(str string)

Success writes a successful message

func (*Stdout) Successf

func (s *Stdout) Successf(format string, a ...interface{})

Successf writes an informational message with format