package errors

import "github.com/pkg/errors"

Package errors provides simple error handling primitives.

The traditional error handling idiom in Go is roughly akin to

if err != nil {
return err
}

which applied recursively up the call stack results in error reports
without context or debugging information. The errors package allows
programmers to add context to the failure path in their code in a way
that does not destroy the original value of the error.

If additional control is required the errors.WithStack and errors.WithMessage
functions destructure errors.Wrap into its component operations of annotating
an error with a stack trace and an a message, respectively.

Using errors.Wrap constructs a stack of errors, adding context to the
preceding error. Depending on the nature of the error it may be necessary
to reverse the operation of errors.Wrap to retrieve the original error
for inspection. Any error value which implements this interface

type causer interface {
Cause() error
}

can be inspected by errors.Cause. errors.Cause will recursively retrieve
the topmost error which does not implement causer, which is assumed to be
the original cause. For example: