records

Documentation

Index

• type Error
  • func WrapError(err error, records ...Record) Error
• type Record
  • func New(plainText string) Record
• type ScreenRecorder
  • func NewScreenRecorder(timeScale float64) ScreenRecorder

Types

type Error

type Error interface {
	error
	Records() []Record
}

Error is an error with attached records

func WrapError

func WrapError(err error, records ...Record) Error

WrapError wraps 'err' with additional records

type Record

type Record interface {
	// ContentType returns the MIME type for this record's data. e.g. image/gif, text/plain
	ContentType() string
	// Data returns the record data in bytes
	Data() []byte
}

Record contains data that can be attached to errors for more context. i.e. screen recording gif

func New

func New(plainText string) Record

type ScreenRecorder

type ScreenRecorder interface {
	Capture(ctx context.Context) error
	Encode() Record
}

ScreenRecorder takes screenshots and encodes them as a gif

func NewScreenRecorder

func NewScreenRecorder(timeScale float64) ScreenRecorder

NewScreenRecorder creates a new ScreenRecorder and stretches the gif frame delay by 'timeScale'