reporter

Documentation

Index

• func HandleError(reporter Interface, err error, message string, args ...interface{}) error
• type Interface
  • func Klog() Interface
  • func Silent() Interface
  • func Stdout() Interface
• type Tracker
  • func NewTracker(forReporter Interface) *Tracker
  • func (t *Tracker) Failure(message string, args ...interface{})
  • func (t *Tracker) HasFailures() bool
  • func (t *Tracker) HasWarnings() bool
  • func (t *Tracker) Start(message string, args ...interface{})
  • func (t *Tracker) Warning(message string, args ...interface{})

Functions

func HandleError

func HandleError(reporter Interface, err error, message string, args ...interface{}) error

Types

type Interface

type Interface interface {
	// Start reports that an operation or sequence of operations is starting;
	// any operation in progress is ended.
	Start(message string, args ...interface{})

	// Success reports that the last operation succeeded with the specified message.
	Success(message string, args ...interface{})

	// Failure reports that the last operation failed with the specified message.
	Failure(message string, args ...interface{})

	// End the current operation that was previously initiated via Start.
	End()

	// Warning reports a warning message for the last operation.
	Warning(message string, args ...interface{})

	// Error wraps err with the supplied message, reports it as a failure, ends the current operation, and returns the error.
	// If err is nil, does nothing and returns nil.
	Error(err error, message string, args ...interface{}) error
}

Interface for reporting on the progress of an operation.

func Klog

func Klog() Interface

func Silent

func Silent() Interface

func Stdout

func Stdout() Interface

type Tracker

type Tracker struct {
	Interface
	// contains filtered or unexported fields
}

func NewTracker

func NewTracker(forReporter Interface) *Tracker

func (*Tracker) Failure

func (t *Tracker) Failure(message string, args ...interface{})

func (*Tracker) HasFailures

func (t *Tracker) HasFailures() bool

func (*Tracker) HasWarnings

func (t *Tracker) HasWarnings() bool

func (*Tracker) Start

func (t *Tracker) Start(message string, args ...interface{})

func (*Tracker) Warning

func (t *Tracker) Warning(message string, args ...interface{})