cerrors

Documentation

Overview

Package cerrors provides a custom error type that can hold more context than the stdlib error package.

Index

• func New(cause error, msg string, tags map[string]interface{}) error
• func WithTags(err error, tags map[string]interface{}) error
• type Error
  • func (e Error) Error() string
  • func (e Error) Unwrap() error

Functions

func New

func New(cause error, msg string, tags map[string]interface{}) error

New creates an error by (optionally) wrapping an existing error and annotating the error with structured tags.

func WithTags

func WithTags(err error, tags map[string]interface{}) error

WithTags annotates an existing error with structured tags.

Types

type Error

type Error struct {
	Message string
	Tags    map[string]interface{}
	Cause   error
}

Error can wrap an error with additional context such as structured tags.

func (Error) Error

func (e Error) Error() string

Error returns a human-friendly string that contains the entire error chain along with all of the tags on each error.

func (Error) Unwrap

func (e Error) Unwrap() error

Unwrap returns the underlying cause of an error (if any).