console

Documentation

Index

• func LogWriter(l LogPrinter) io.Writer
• type LogPrinter
• type Logger
  • func FromCtx(c context.Context) *Logger
  • func NewLogger(w io.Writer, opts ...Opt) *Logger
  • func (l *Logger) Ctx(c context.Context) context.Context
  • func (l *Logger) Print(output string, opts ...PrintOption) error
  • func (l *Logger) WithPrefix(pfx string) *Logger
• type Opt
  • func Verbose() Opt
• type PrintOption
  • func AsVerbose() PrintOption
  • func Fmt(args ...any) PrintOption
  • func NewlinePfx() PrintOption
  • func Once() PrintOption

Functions

func LogWriter

func LogWriter(l LogPrinter) io.Writer

LogWriter wraps up l in an io.Writer to be used for console logging.

Types

type LogPrinter

type LogPrinter interface {
	Log(...any)
}

LogPrinter is a type which has a Log method. The main example is testing.T.

type Logger

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

Logger is a type which may be used to write logs to a console.

func FromCtx

func FromCtx(c context.Context) *Logger

FromCtx retrieves a Logger from c.

func NewLogger

func NewLogger(w io.Writer, opts ...Opt) *Logger

NewLogger constructs a Logger to write to w.

func (*Logger) Ctx

func (l *Logger) Ctx(c context.Context) context.Context

Ctx returns a child context.Context with l set as the context's logger.

func (*Logger) Print

func (l *Logger) Print(output string, opts ...PrintOption) error

Print prints a line of output to the console.

func (*Logger) WithPrefix

func (l *Logger) WithPrefix(pfx string) *Logger

WithPrefix returns a new Logger with pfx added. Any existing prefix in l will be prepended.

type Opt

type Opt func(*Logger)

func Verbose

func Verbose() Opt

type PrintOption

type PrintOption func(printPrefs) printPrefs

func AsVerbose

func AsVerbose() PrintOption

AsVerbose marks the message as a verbose message, only printing if the console logger is in verbose mode.

func Fmt

func Fmt(args ...any) PrintOption

Fmt adds format args to the print statement.

func NewlinePfx

func NewlinePfx() PrintOption

NewlinePfx changes the message to _start_ with a newline, rather than end with one. Loggers usually end every message with a newline. This moves the newline to the start.

func Once

func Once() PrintOption

Once ensures that this message is only printed once. This is useful for messages that might get repeated by multiple goroutines.