errutils

README

Errors (errutils)

• NewErrorAggregator: Creates a new error aggregator to collect multiple errors.
• Add: Adds an error to the aggregator.
• Error: Retrieves the aggregated error message.
• HasErrors: Checks if there are any errors in the aggregator.

Examples:

For examples of each function, please checkout EXAMPLES.md

---

Documentation

Overview

Package errutils provides utilities for error aggregation and handling.

Index

• type ErrorAggregator
  • func NewErrorAggregator() *ErrorAggregator
  • func (e *ErrorAggregator) Add(err error)
  • func (e *ErrorAggregator) Error() error
  • func (e *ErrorAggregator) ErrorList() []error
  • func (e *ErrorAggregator) HasErrors() bool

Types

type ErrorAggregator

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

ErrorAggregator aggregates multiple errors into a single error.

func NewErrorAggregator

func NewErrorAggregator() *ErrorAggregator

NewErrorAggregator creates a new instance of ErrorAggregator.

func (*ErrorAggregator) Add

func (e *ErrorAggregator) Add(err error)

Add adds a new error to the aggregator. If err is nil, it is ignored.

func (*ErrorAggregator) Error

func (e *ErrorAggregator) Error() error

Error returns the aggregated errors as a single error message. If there are no errors, it returns nil.

func (*ErrorAggregator) ErrorList

func (e *ErrorAggregator) ErrorList() []error

ErrorList returns the list of aggregated errors as a slice.

func (*ErrorAggregator) HasErrors

func (e *ErrorAggregator) HasErrors() bool

HasErrors returns true if there are any aggregated errors.