wraperror

README

go-wraperror

WrapError is custom error struct implemented error interface and supporting errors.As, errors.Is, Unwrap ... and so on.

Getting Started

package main
import (
	"os"
	"errors"
	wraperror "github.com/gjbae1212/go-wraperror"
)


func main() {
	sample1 := errors.New("[err] tests")
	sample2 := &os.PathError{}
	sample3 := &os.SyscallError{}

	wrap := wraperror.Error(sample1)
	wrap = wrap.Wrap(sample2)

	// true
	errors.Is(wrap, sample1)
	errors.As(wrap, &sample1)
	// true
	errors.Is(wrap, sample2)
	errors.As(wrap, &sample2)
	// false
	errors.Is(wrap, sample3)
	errors.As(wrap, &sample3)
}

LICENSE

This project is following The MIT.

Documentation

Index

• type WrapError
  • func Error(err error) *WrapError
  • func FromError(err error) (*WrapError, bool)
  • func (e *WrapError) As(target interface{}) bool
  • func (e *WrapError) Child() error
  • func (e *WrapError) Current() error
  • func (e *WrapError) Error() string
  • func (e *WrapError) Flatten() []error
  • func (e *WrapError) Is(target error) bool
  • func (e *WrapError) Unwrap() error
  • func (e *WrapError) Wrap(err error) *WrapError

Types

type WrapError

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

WrapError is custom error struct implemented error interface, supporting As, Is, Unwrap.

func Error

func Error(err error) *WrapError

Error converts error to WrapError.

func FromError

func FromError(err error) (*WrapError, bool)

FromError returns an error to WrapError, but if an error doesn't convert to WrapError, returning nil and false.

func (*WrapError) As

func (e *WrapError) As(target interface{}) bool

As Checks to equal e.child to err. It's implemented for errors package.

func (*WrapError) Child

func (e *WrapError) Child() error

Child returns child error.

func (*WrapError) Current

func (e *WrapError) Current() error

Current returns current error.

func (*WrapError) Error

func (e *WrapError) Error() string

Error returns a chained error string. It's implemented error interface.

func (*WrapError) Flatten

func (e *WrapError) Flatten() []error

Flatten returns an flatten error array.

func (*WrapError) Is

func (e *WrapError) Is(target error) bool

Is checks to equal e.current to err. It's implemented for errors package.

func (*WrapError) Unwrap

func (e *WrapError) Unwrap() error

Unwrap unwraps an error. It's implemented for errors package.

func (*WrapError) Wrap

func (e *WrapError) Wrap(err error) *WrapError

Wrap wraps an error.