verbose

Documentation

Index

• Variables
• type Printer
  • func NewPrinter(writer io.Writer, prefix string) Printer
  • func NewPrinterForFlagValue(writer io.Writer, prefix string, verboseValue bool) Printer

Variables

var (
	// NopPrinter is a no-op printer.
	//
	// This generally aligns with the --verbose flag not being set.
	NopPrinter = nopPrinter{}
)

Types

type Printer

type Printer interface {
	// Enabled returns true if verbose mode is enabled.
	//
	// This is false if the Printer is a no-op printer.
	Enabled() bool
	// Printf prints a new verbose message.
	//
	// Leading and trailing newlines are not respected.
	//
	// Callers should not rely on the print calls being reliable, i.e. errors to
	// a backing Writer will be ignored.
	Printf(format string, args ...interface{})
	// contains filtered or unexported methods
}

Printer prints verbose messages.

func NewPrinter

func NewPrinter(writer io.Writer, prefix string) Printer

NewPrinter returns a new Printer using the given Writer.

The trimmed prefix is printed with a : before each line.

This generally aligns with the --verbose flag being set and writer being stderr.

func NewPrinterForFlagValue

func NewPrinterForFlagValue(writer io.Writer, prefix string, verboseValue bool) Printer

NewPrinterForFlagValue returns a new Printer for the given verboseValue flag value.