README
¶
🧯 Errors
Errors 是一个用于优雅地处理 Go 中错误的库。
🙋 功能特性
- 优雅地处理 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.RequestTimeout(nil) // Classic enough! Ah :)
err = errors.InternalServerError(nil) // Classic enough! Ah :)
err = errors.DBError(nil)
err = errors.PageTokenInvalid(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))
fmt.Println(errors.MsgOrDefault(io.EOF, "default error message"))
}
👥 贡献者
如果您觉得 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 IsNotFound(err error) bool
- func IsPageTokenInvalid(err error) bool
- func IsRequestTimeout(err error) bool
- func Msg(err error) (string, bool)
- func MsgOrDefault(err error, defaultMsg string) string
- func New(text string) error
- func Newf(text string, params ...interface{}) error
- func NotFound(err error, opts ...Option) error
- func PageTokenInvalid(err error, opts ...Option) error
- func RequestTimeout(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 UnwrapNotFound(err error) (error, bool)
- func UnwrapPageTokenInvalid(err error) (error, bool)
- func UnwrapRequestTimeout(err error) (error, bool)
- func Wrap(err error, code int32, opts ...Option) error
- type Error
- type Option
Constants ¶
This section is empty.
Variables ¶
Functions ¶
func BadRequest ¶ added in v0.0.3
BadRequest returns a bad request error.
func InternalServerError ¶ added in v0.0.3
InternalServerError returns an internal server error.
func IsBadRequest ¶ added in v0.0.3
IsBadRequest if err is bad request.
func IsForbidden ¶ added in v0.0.4
IsForbidden if err is forbidden.
func IsInternalServerError ¶ added in v0.0.3
IsInternalServerError if err is an internal server.
func IsPageTokenInvalid ¶ added in v0.5.0
IsPageTokenInvalid if err is page token invalid.
func IsRequestTimeout ¶ added in v0.5.0
IsRequestTimeout if err is request timeout.
func MsgOrDefault ¶ added in v0.4.0
MsgOrDefault returns the msg of err or defaultMsg if err doesn't have a msg.
func PageTokenInvalid ¶ added in v0.5.0
PageTokenInvalid returns a page token invalid error.
func RequestTimeout ¶ added in v0.5.0
RequestTimeout returns a request timeout error.
func Unwrap ¶ added in v0.0.2
Unwrap returns if err is Error and its code == code, and the original error will be returned, too.
func UnwrapBadRequest ¶ added in v0.0.3
UnwrapBadRequest if err is bad request.
func UnwrapDBError ¶ added in v0.0.2
UnwrapDBError if err is db error.
func UnwrapForbidden ¶ added in v0.0.4
UnwrapForbidden if err is forbidden.
func UnwrapInternalServerError ¶ added in v0.0.3
UnwrapInternalServerError if err is an internal server.
func UnwrapNotFound ¶ added in v0.0.2
UnwrapNotFound if err is not found.
func UnwrapPageTokenInvalid ¶ added in v0.5.0
UnwrapPageTokenInvalid if err is page token invalid.
func UnwrapRequestTimeout ¶ added in v0.5.0
UnwrapRequestTimeout if err is request timeout.
Source Files
Directories