log

Documentation

Index

• type Logger
• type NOOPLogger
  • func (NOOPLogger) Printf(format string, v ...interface{})
  • func (NOOPLogger) Println(v ...interface{})
• type TestLog
  • func NewTestLogger(l testLogger, prefix string) *TestLog
  • func (t *TestLog) Printf(format string, v ...interface{})
  • func (t *TestLog) Println(v ...interface{})

Types

type Logger

type Logger interface {
	Println(v ...interface{})
	Printf(format string, v ...interface{})
}

Logger interface allows implementations to provide to this package any object that implements the methods defined in it.

type NOOPLogger

type NOOPLogger struct{}

NOOPLogger implements the logger that does not perform any operation by default. This allows us to efficiently discard the unwanted messages.

func (NOOPLogger) Printf

func (NOOPLogger) Printf(format string, v ...interface{})

Printf is the library provided NOOPLogger's implementation of the required interface function(){}

func (NOOPLogger) Println

func (NOOPLogger) Println(v ...interface{})

Println is the library provided NOOPLogger's implementation of the required interface function()

type TestLog

type TestLog struct {
	sync.Mutex
	// contains filtered or unexported fields
}

The TestLog type is an adapter to allow the use of testing.T as a paho.Logger. With this implementation, log messages will only be output when a test fails (and will be associated with the test).

func NewTestLogger

func NewTestLogger(l testLogger, prefix string) *TestLog

NewTestLogger accepts a testLogger (e.g. Testing.T) and a prefix (added to messages logged) and returns a Logger

func (*TestLog) Printf

func (t *TestLog) Printf(format string, v ...interface{})

Printf formats its arguments according to the format, analogous to fmt.Printf, and records the text in the test log (only printed if the test files or appropriate arguments passed to go test).

func (*TestLog) Println

func (t *TestLog) Println(v ...interface{})

Println prints a line to the log Println its arguments in the test log (only printed if the test files or appropriate arguments passed to go test).