README
¶
errors
This package provides helpers to deal with error handling in go programs
Features
Error Slice
errs := errors.NewSlice()
errs = errs.Add(errors.New("err1"))
errs = errs.Add(errors.New("err2"))
errs = errors.MergeSlice(errs, errors.New("err3"), errors.Slice{errors.New("err4)})
Error Map
errs := errors.NewMap()
errs = errs.Add("field1", errors.New("err1"))
errs = errs.Add("field2", errors.New("err2"))
errs = errors.MergeMap(errs, errors.Map{"field3": errors.New("err3)})
Wrap, Wrapf, WithStack
There are wrappers for the most used functions from the github.com/pkg/errors package
Marshaling according to PROD-03
MarshalToJSON, MarshalToYAML and MarshalToObject are supported
errSlice := errors.Slice{errors.New("err1"),errors.New("err2")}
errMap := errors.Map{"f1": errors.New("err3")}
buf := &bytes.Buffer{}
errors.MarshalToJSON(buf, errSlice, errMap, errors.New("err4"))
fmt.Print(buf.String())
// prints: { "errors": ["err1", "err2", "err4"], "fieldErrors": {"f1": "err3"} }
Documentation
¶
Index ¶
- func IsMap(err error) bool
- func IsSlice(err error) bool
- func MarshalToJSON(writer io.Writer, err error, additionalErrors ...error) error
- func MarshalToObject(err error, additionalErrors ...error) map[string]interface{}
- func MarshalToYAML(writer io.Writer, err error, additionalErrors ...error) error
- func WithStack(err error) error
- func Wrap(err error, message string) error
- func Wrapf(err error, format string, args ...interface{}) error
- type Error
- type Map
- type Slice
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func MarshalToJSON ¶
MarshalToJSON an error to a json encoded error object
func MarshalToObject ¶
MarshalToObject marshals to a map[string]interface{}, usable to marshal to different formats
func MarshalToYAML ¶
MarshalToYAML marshals an error to a yaml encoded error object
Types ¶
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
Error is a marshalable error note that you loose any extra information other than the actual message when marshaling/unmarshaling
func New ¶
func New(e interface{}) *Error
New creates a new marshalable error it may take a string or another error
func (*Error) MarshalJSON ¶
MarshalJSON implements the json.Marshaler interface
func (*Error) UnmarshalJSON ¶
UnmarshalJSON implements the json.Unmarshaler interface
type Map ¶
Map is a map from string to error
Source Files