errorx

README

go-errorx

Extended error logging library for Golang

---

---

Table of Contents

• 👁️ Overview
• ✅ Requirements
• 📃 License
• ❓ Questions, Issues and Feature Requests

👁️ Overview

go-errorx provides extended error logging for Go applications and packages. It extends the error interface by adding the ability to include an error code, nested errors, and any attributes associated with the error.

Please review the module documentation for details on how to properly the functions and classes contained in this module.

✅ Requirements

This module is supported for Go v1.18 and later.

📃 License

This module is distributed under the MIT License.

❓ Questions, Issues and Feature Requests

If you have questions about this project, find a bug or wish to submit a feature request, please submit an issue.

Documentation

Overview

Package errorx provides extended error handling functionality.

Index

• type BaseError
  • func NewBaseError(code int, err error) *BaseError
  • func (b *BaseError) Append(errs ...Error)
  • func (b *BaseError) Attr(key string) (any, error)
  • func (b *BaseError) AttrDuration(key string) (time.Duration, error)
  • func (b *BaseError) AttrInt(key string) (int, error)
  • func (b *BaseError) AttrInt64(key string) (int64, error)
  • func (b *BaseError) AttrString(key string) (string, error)
  • func (b *BaseError) AttrTime(key string) (time.Time, error)
  • func (b *BaseError) AttrUint(key string) (uint, error)
  • func (b *BaseError) AttrUint64(key string) (uint64, error)
  • func (b *BaseError) Attrs() map[string]any
  • func (b *BaseError) Code() int
  • func (b *BaseError) Error() string
  • func (b *BaseError) InternalError() error
  • func (b *BaseError) NestedErrors() []Error
  • func (b *BaseError) WithAttr(attrKey string, attrValue any) *BaseError
  • func (b *BaseError) WithAttrs(attrs map[string]any) *BaseError
• type Error

Types

type BaseError

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

BaseError is a base error object that mostly implements the Error interface and can be used to more easily compose more type-specific errors. Composed objects must implement the Error() function.

Do not create this object directly. Use NewBaseError() to construct a new object so its values are initialized properly.

func NewBaseError

func NewBaseError(code int, err error) *BaseError

NewBaseError returns a new BaseError object without caller information enabled.

func (*BaseError) Append

func (b *BaseError) Append(errs ...Error)

Append appends one or more non-nil errors to the end of the list of nested errors associated with this error.

Any nil errors passed are ignored.

func (*BaseError) Attr

func (b *BaseError) Attr(key string) (any, error)

Attr returns the value of the attribute with the given key if it exists.

func (*BaseError) AttrDuration

func (b *BaseError) AttrDuration(key string) (time.Duration, error)

AttrDuration returns the value of the attribute with the given key (if it exists) as a time duration.

func (*BaseError) AttrInt

func (b *BaseError) AttrInt(key string) (int, error)

AttrInt returns the value of the attribute with the given key (if it exists) as an integer if it exists.

func (*BaseError) AttrInt64

func (b *BaseError) AttrInt64(key string) (int64, error)

AttrInt64 returns the value of the attribute with the given key (if it exists) as a 64-bit integer.

func (*BaseError) AttrString

func (b *BaseError) AttrString(key string) (string, error)

AttrString returns the value of the attribute with the given key (if it exists) as a string.

func (*BaseError) AttrTime

func (b *BaseError) AttrTime(key string) (time.Time, error)

AttrTime returns the value of the attribute with the given key (if it exists) as a time object.

func (*BaseError) AttrUint

func (b *BaseError) AttrUint(key string) (uint, error)

AttrUint returns the value of the attribute with the given key (if it exists) as an unsigned integer.

func (*BaseError) AttrUint64

func (b *BaseError) AttrUint64(key string) (uint64, error)

AttrUint64 returns the value of the attribute with the given key (if it exists) as an unsigned 64-bit integer.

func (*BaseError) Attrs

func (b *BaseError) Attrs() map[string]any

Attrs returns all of the attributes associated with the error.

If this object has no attributes defined, an empty map is returned.

func (*BaseError) Code

func (b *BaseError) Code() int

Code returns the error code.

func (*BaseError) Error

func (b *BaseError) Error() string

Error returns the corresponding error message.

func (*BaseError) InternalError

func (b *BaseError) InternalError() error

InternalError returns the standard error associated with the object.

The error returned by this function is guaranteed to never be `nil`.

func (*BaseError) NestedErrors

func (b *BaseError) NestedErrors() []Error

NestedErrors returns the list of errors that were generated by a call to another function.

If there are no nested errors, an empty list is returned.

func (*BaseError) WithAttr

func (b *BaseError) WithAttr(attrKey string, attrValue any) *BaseError

WithAttr adds the given key/value pair to the list of attributes associated with this error and returns itself

func (*BaseError) WithAttrs

func (b *BaseError) WithAttrs(attrs map[string]any) *BaseError

WithAttrs adds each of the given key/value pairs to the list of attributes associated with this error and returns itself.

type Error

type Error interface {
	// Attrs should return any additional attributes which may be used when logging the error.
	Attrs() map[string]any

	// Code should return the corresponding error code.
	Code() int

	// Error should return the string version of the error.
	Error() string

	// InternalError should return the internal standard error object if there is one.
	InternalError() error

	// NestedErrors should return the list of nested errors if there are any.
	NestedErrors() []Error
}

Error represents an extension to the standard error interface by adding the ability to include an error code, nested errors, and any attributes associated with the error.