errors

README

🔧 Errors

Errors 是一个用于优雅地处理 Go 中错误的库。

Read me in English

🙋‍ 功能特性

• 优雅地处理 error，嗯，没了。。。

历史版本的特性请查看 HISTORY.md。未来版本的新特性和计划请查看 FUTURE.md。

package main

import (
	"fmt"
	"io"

	"github.com/FishGoddess/errors"
)

const (
	codeTestError = 10000 // Your error's code
)

// TestError returns a test error.
func TestError(err error) error {
	return errors.Wrap(err, codeTestError)
}

// IsTestError if err is test error.
func IsTestError(err error) bool {
	return errors.Is(err, codeTestError)
}

func main() {
	// We provide three graceful ways to handle error in Go: Wrap() and Unwrap() and Is().
	// Wrap wraps error with a code and Unwrap returns one error with this code.
	// Is returns one error is with the same code or not.
	// As you can see, we define two functions above, and this is the basic way to use this lib.
	err := TestError(errors.New("something wrong"))
	if IsTestError(err) {
		fmt.Println("I got a test error")
	}

	// Also, we provide some basic errors for you:
	err = errors.BadRequest(nil)          // Classic enough! Ah :)
	err = errors.Forbidden(nil)           // Classic enough! Ah :)
	err = errors.NotFound(nil)            // Classic enough! Ah :)
	err = errors.InternalServerError(nil) // Classic enough! Ah :)
	err = errors.Timeout(nil)
	err = errors.NetworkError(nil)
	err = errors.DBError(nil)

	// Use WithMsg to carry a message.
	err = errors.Wrap(io.EOF, codeTestError, errors.WithMsg("test"))
	fmt.Println(err.Error())
	fmt.Println(errors.Msg(err))
}

👥 贡献者

如果您觉得 Errors 缺少您需要的功能，那就 fork 到自己仓库随便玩。当然，也可以提 issue :)。

Documentation

Index

• Variables
• func BadRequest(err error, opts ...Option) error
• func DBError(err error, opts ...Option) error
• func Forbidden(err error, opts ...Option) error
• func InternalServerError(err error, opts ...Option) error
• func Is(err error, code int32) bool
• func IsBadRequest(err error) bool
• func IsDBError(err error) bool
• func IsForbidden(err error) bool
• func IsInternalServerError(err error) bool
• func IsNetworkError(err error) bool
• func IsNotFound(err error) bool
• func IsTimeout(err error) bool
• func Msg(err error) string
• func NetworkError(err error, opts ...Option) error
• func New(text string) error
• func NewF(text string, params ...interface{}) error
• func NotFound(err error, opts ...Option) error
• func Timeout(err error, opts ...Option) error
• func Unwrap(err error, code int32) (error, bool)
• func UnwrapBadRequest(err error) (error, bool)
• func UnwrapDBError(err error) (error, bool)
• func UnwrapForbidden(err error) (error, bool)
• func UnwrapInternalServerError(err error) (error, bool)
• func UnwrapNetworkError(err error) (error, bool)
• func UnwrapNotFound(err error) (error, bool)
• func UnwrapTimeout(err error) (error, bool)
• func Wrap(err error, code int32, opts ...Option) error
• type Error
  • func (e *Error) Error() string
  • func (e *Error) Is(target error) bool
  • func (e *Error) String() string
  • func (e *Error) Unwrap() error
• type Option
  • func WithMsg(msg string, params ...interface{}) Option
  • func (o Option) Apply(e *Error)

Variables

var (
	// FormatError formats e and returns a string in Error().
	FormatError = func(e *Error) string {
		return e.err.Error()
	}

	// FormatString formats e and returns a string in String().
	FormatString = func(e *Error) string {
		return fmt.Sprintf("%d (%s)", e.code, e.msg)
	}
)

Functions

func BadRequest

func BadRequest(err error, opts ...Option) error

BadRequest returns a bad request error.

func DBError

func DBError(err error, opts ...Option) error

DBError returns a db error.

func Forbidden

func Forbidden(err error, opts ...Option) error

Forbidden returns a forbidden error.

func InternalServerError

func InternalServerError(err error, opts ...Option) error

InternalServerError returns an internal server error.

func Is

func Is(err error, code int32) bool

Is returns if err is Error and its code == code.

func IsBadRequest

func IsBadRequest(err error) bool

IsBadRequest if err is bad request.

func IsDBError

func IsDBError(err error) bool

IsDBError if err is db error.

func IsForbidden

func IsForbidden(err error) bool

IsForbidden if err is forbidden.

func IsInternalServerError

func IsInternalServerError(err error) bool

IsInternalServerError if err is an internal server.

func IsNetworkError

func IsNetworkError(err error) bool

IsNetworkError if err is network error.

func IsNotFound

func IsNotFound(err error) bool

IsNotFound if err is not found.

func IsTimeout

func IsTimeout(err error) bool

IsTimeout if err is timeout.

func Msg

func Msg(err error) string

Msg returns the msg of err.

func NetworkError

func NetworkError(err error, opts ...Option) error

NetworkError returns a network error.

func New

func New(text string) error

New returns a string error.

func NewF

func NewF(text string, params ...interface{}) error

NewF returns a string error.

func NotFound

func NotFound(err error, opts ...Option) error

NotFound returns a not found error.

func Timeout

func Timeout(err error, opts ...Option) error

Timeout returns a timeout error.

func Unwrap

func Unwrap(err error, code int32) (error, bool)

Unwrap returns if err is Error and its code == code, and the original error will be returned, too.

func UnwrapBadRequest

func UnwrapBadRequest(err error) (error, bool)

UnwrapBadRequest if err is bad request.

func UnwrapDBError

func UnwrapDBError(err error) (error, bool)

UnwrapDBError if err is db error.

func UnwrapForbidden

func UnwrapForbidden(err error) (error, bool)

UnwrapForbidden if err is forbidden.

func UnwrapInternalServerError

func UnwrapInternalServerError(err error) (error, bool)

UnwrapInternalServerError if err is an internal server.

func UnwrapNetworkError

func UnwrapNetworkError(err error) (error, bool)

UnwrapNetworkError if err is network error.

func UnwrapNotFound

func UnwrapNotFound(err error) (error, bool)

UnwrapNotFound if err is not found.

func UnwrapTimeout

func UnwrapTimeout(err error) (error, bool)

UnwrapTimeout if err is timeout.

func Wrap

func Wrap(err error, code int32, opts ...Option) error

Wrap wraps err with code

Types

type Error

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

Error wraps err with some information.

func (*Error) Error

func (e *Error) Error() string

func (*Error) Is

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

Is returns if e has the same type of target.

func (*Error) String

func (e *Error) String() string

func (*Error) Unwrap

func (e *Error) Unwrap() error

Unwrap returns err inside.

type Option

type Option func(e *Error)

func WithMsg

func WithMsg(msg string, params ...interface{}) Option

WithMsg sets msg to e.

func (Option) Apply

func (o Option) Apply(e *Error)