errors

README

errors

errors package is a wrapper around Go's errors package. It provides a way to wrap errors with additional context about where the error occurred.

It's a simple package to avoid the need to write the following boilerplate to make errors easier to track.

if _, err := os.Open("non-existent-file"); err != nil {
	return fmt.Errorf("os.Remove: %w", err)
}

Instead, you can write:

if _, err := os.Open("non-existent-file"); err != nil {
	return errors.Wrap(err)
}

The error will be wrapped with the file and line number where the error occurred. Error will return a string like:

example.go:17: file does not exist

Documentation

Index

• func As(err error, target any) bool
• func Is(err, target error) bool
• func New(msg string) error
• func Unwrap(err error) error
• func Wrap(err error) error

Functions

func As

func As(err error, target any) bool

As is a convenience wrapper around errors.As.

func Is

func Is(err, target error) bool

Is is a convenience wrapper around errors.Is.

func New

func New(msg string) error

New is a convenience wrapper around errors.New.

func Unwrap

func Unwrap(err error) error

Unwrap is a convenience wrapper around errors.Unwrap.

func Wrap

func Wrap(err error) error

Wrap wraps an error with the file and line where it was called.