README
¶
🧯 Errors
Errors 是一个用于优雅地处理 Go 中错误的库。
🙋 功能特性
- 优雅地处理错误，嗯，没了。。。
历史版本的特性请查看 HISTORY.md。未来版本的新特性和计划请查看 FUTURE.md。
package main
import (
"fmt"
"io"
"github.com/FishGoddess/errors"
)
func main() {
// Use wrap function to create an *Error error which has code and message.
// You can get code and message of err anytime.
err := errors.Wrap(1000, "need login")
fmt.Println(err)
fmt.Println(err.Code(), err.Message())
// Try these ways to get code and message!
// You will get default code or message if err doesn't have a code or message.
code := errors.Code(err, 6699)
message := errors.Message(err, "default message")
fmt.Println(code, message)
code = errors.Code(io.EOF, 6699)
message = errors.Message(io.EOF, "default message")
fmt.Println(code, message)
// Also, we provide some useful information carrier for you.
// For examples, you can carry an error, caller information or some args.
// Remember the count of args should be even and their keys should be a string.
err = errors.Wrap(9999, "io timeout").With(io.EOF).WithCaller().WithArgs("user_id", 123, "timeout", "200ms")
fmt.Println(err)
fmt.Println(errors.CodeMessage(err, 6666, "default message"))
// What's more, we provide some shortcuts for you.
// All these ways are returning *Error and you are free to use all methods on *Error.
berr := errors.BadRequest("id is wrong")
ferr := errors.Forbidden("user isn't allowed")
nerr := errors.NotFound("book not found")
rerr := errors.RequireLogin("user requires login")
fmt.Printf("%+v\n%+v\n%+v\n%+v\n", berr, ferr, nerr, rerr)
isBadRequest := errors.MatchBadRequest(berr)
isForbidden := errors.MatchForbidden(ferr)
isNotFound := errors.MatchNotFound(nerr)
isRequireLogin := errors.MatchRequireLogin(rerr)
fmt.Printf("isBadRequest: %+v\nisForbidden: %+v\nisNotFound: %+v\nisRequireLogin: %+v\n", isBadRequest, isForbidden, isNotFound, isRequireLogin)
}
👥 贡献者
如果您觉得 errors 缺少您需要的功能，那就 fork 到自己仓库随便玩。当然，也可以提 issue :)。
Documentation
¶
Index ¶
- func As(err error, target any) bool
- func Caller() string
- func Callers() []string
- func Code(err error, defaultCode int32) int32
- func CodeMessage(err error, defaultCode int32, defaultMessage string, args ...any) (int32, string)
- func Is(err, target error) bool
- func Join(errs ...error) error
- func Match(err error, code int32) bool
- func MatchBadRequest(err error) bool
- func MatchForbidden(err error) bool
- func MatchNotFound(err error) bool
- func MatchRequireLogin(err error) bool
- func Message(err error, defaultMessage string, args ...any) string
- func New(text string) error
- func Unwrap(err error) error
- type Error
- func (e *Error) Args() map[string]any
- func (e *Error) Code() int32
- func (e *Error) Error() string
- func (e *Error) Message() string
- func (e *Error) String() string
- func (e *Error) Unwrap() error
- func (e *Error) With(err error) *Error
- func (e *Error) WithArgs(args ...any) *Error
- func (e *Error) WithCaller() *Error
- func (e *Error) WithCallers() *Error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Code ¶ added in v0.3.0
Code unwraps error and gets code of it. It returns 0 if err is nil. It returns defaultCode if err doesn't have a code.
func CodeMessage ¶ added in v0.7.0
CodeMessage unwraps error and gets code & message of it. It returns 0 & "" if err is nil. It returns defaultCode if err doesn't have a code. It returns defaultMessage if err doesn't have a message.
func MatchBadRequest ¶ added in v0.7.0
MatchBadRequest matches err with bad request code.
func MatchForbidden ¶ added in v0.7.0
MatchForbidden matches err with forbidden code.
func MatchNotFound ¶ added in v0.7.0
MatchNotFound matches err with not found code.
func MatchRequireLogin ¶ added in v0.7.0
MatchRequireLogin matches err with require login code.
Types ¶
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
func BadRequest ¶ added in v0.0.3
BadRequest returns *Error with bad request code.
func RequireLogin ¶ added in v0.7.0
RequireLogin returns *Error with require login code.
func (*Error) WithCaller ¶ added in v0.7.0
WithCaller carries the top caller for *Error.
func (*Error) WithCallers ¶ added in v0.7.0
WithCallers carries all callers for *Error.
Source Files
Directories