console

Documentation

Index

• type ColorFormatter
  • func (f ColorFormatter) Format(e entry.Entry) string
• type Formatter
• type Option
  • func WithFormatter(f Formatter) Option
  • func WithStream(s io.WriteCloser) Option
• type TextFormatter
  • func (f TextFormatter) Format(e entry.Entry) string
• type Writer
  • func NewWriter(opts ...Option) *Writer
  • func (w *Writer) Close()
  • func (w *Writer) Write(e entry.Entry)

Types

type ColorFormatter

type ColorFormatter struct {
}

ColorFormatter implements the "Formatter" interface nad generated colored console output

func (ColorFormatter) Format

func (f ColorFormatter) Format(e entry.Entry) string

Format formats an entry

type Formatter

type Formatter interface {
	Format(entry.Entry) string
}

Formatter defines the interface for formatting entries for console output

type Option

type Option func(w *Writer)

Option is the console-writer option type

func WithFormatter

func WithFormatter(f Formatter) Option

WithFormatter configures the console writer to use the provided Formatter

func WithStream

func WithStream(s io.WriteCloser) Option

WithStream configures the console writer to use the provided io.Writer

type TextFormatter

type TextFormatter struct{}

func (TextFormatter) Format

func (f TextFormatter) Format(e entry.Entry) string

type Writer

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

Writer is the standard console writer and implements the log.Writer interface

func NewWriter

func NewWriter(opts ...Option) *Writer

NewWriter creates a new console-writer with the provided options

func (*Writer) Close

func (w *Writer) Close()

Close closes the Writer

func (*Writer) Write

func (w *Writer) Write(e entry.Entry)

Write writes a log.Entry to the writer stream