errbuf

README

errbuf

Simple module for go applications, which allows to collect errors into a buffer.

Documentation

Overview

Package errbuf allows to bufferize errors before processing them.

Index

• type BufferedError
  • func New() *BufferedError
  • func NewBufferFromError(err error) *BufferedError
  • func NewBufferFromWarning(err error) *BufferedError
  • func NewErrorsBuffer() *BufferedError
  • func NewFromError(err error) *BufferedError
  • func (b *BufferedError) Add(errs ...error)
  • func (b *BufferedError) Clear()
  • func (b *BufferedError) Err() error
  • func (b *BufferedError) Error() string
  • func (b *BufferedError) Format(f fmt.State, verb rune)
  • func (b *BufferedError) Grow(n int)
  • func (b *BufferedError) Unwrap() []error

Types

type BufferedError

type BufferedError struct {
	sync.RWMutex
	// contains filtered or unexported fields
}

BufferedError wrapper around errors slice with mutex.

func New

func New() *BufferedError

New creates empty BufferedError.

func NewBufferFromError

func NewBufferFromError(err error) *BufferedError

NewBufferFromError creates new BufferedError from the given error.

Deprecated: use NewFromError instead.

func NewBufferFromWarning

func NewBufferFromWarning(err error) *BufferedError

NewBufferFromWarning creates new BufferedError and adds given error to warnings.

Deprecated: warnings buffer was removed.

func NewErrorsBuffer

func NewErrorsBuffer() *BufferedError

NewErrorsBuffer creates empty BufferedError.

Deprecated: use New instead.

func NewFromError

func NewFromError(err error) *BufferedError

NewFromError creates new BufferedError from the given error.

func (*BufferedError) Add

func (b *BufferedError) Add(errs ...error)

Add adds given error to the errors buffer. No-op if errors len is 0.

func (*BufferedError) Clear

func (b *BufferedError) Clear()

Clear clears internal slice of errors. Freed memory will be collected by GC.

func (*BufferedError) Err

func (b *BufferedError) Err() error

Err returns nil if error buffer is empty or contains only nil errors.

func (*BufferedError) Error

func (b *BufferedError) Error() string

Error formats errors in the buffer into the string.

func (*BufferedError) Format

func (b *BufferedError) Format(f fmt.State, verb rune)

func (*BufferedError) Grow

func (b *BufferedError) Grow(n int)

Grow grows internal errors slice capacity to hold n number of errors. If actual capacity is bigger than n this function is no-op.

func (*BufferedError) Unwrap

func (b *BufferedError) Unwrap() []error

Unwrap returns a copy of the buffer errors.