trace

Documentation

Overview

Package trace provides a decorator for io.ReadWriter that logs all reads and writes.

Index

• type Logger
• type Option
  • func WithLogger(l Logger) Option
  • func WithReadFormat(format string) Option
  • func WithWriteFormat(format string) Option
• type Trace
  • func New(rw io.ReadWriter, options ...Option) *Trace
  • func (t *Trace) Read(p []byte) (n int, err error)
  • func (t *Trace) Write(p []byte) (n int, err error)

Types

type Logger

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

Logger defines the interface used to log trace messages.

type Option

type Option func(*Trace)

Option modifies a Trace object created by New.

func WithLogger

func WithLogger(l Logger) Option

WithLogger specifies the logger to be used to log trace messages.

By default traces are logged to Stdout.

func WithReadFormat

func WithReadFormat(format string) Option

WithReadFormat sets the format used for read logs.

func WithWriteFormat

func WithWriteFormat(format string) Option

WithWriteFormat sets the format used for write logs.

type Trace

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

Trace is a trace log on an io.ReadWriter.

All reads and writes are written to the logger.

func New

func New(rw io.ReadWriter, options ...Option) *Trace

New creates a new trace on the io.ReadWriter.

func (*Trace) Read

func (t *Trace) Read(p []byte) (n int, err error)

func (*Trace) Write

func (t *Trace) Write(p []byte) (n int, err error)