调整代码

Author: FishGoddess

HISTORY.md

@@ -1,5 +1,13 @@
 ## ✒ 历史版本的特性介绍 (Features in old versions)
 
+### v0.4.0
+
+> 此版本发布于 2023-06-18
+
+* 去除 Code 函数
+* 调整代码结构
+* 调整 Msg 使用姿势
+
 ### v0.3.0
 
 > 此版本发布于 2023-06-18

README.en.md

@@ -1,4 +1,4 @@
-# 🔧 Errors
+# 🧯 Errors
 
 [![Go Doc](_icons/godoc.svg)](https://pkg.go.dev/github.com/FishGoddess/errors)
 [![License](_icons/license.svg)](https://opensource.org/licenses/MIT)
@@ -61,9 +61,10 @@ func main() {
 	// Use WithMsg to carry a message.
 	err = errors.Wrap(io.EOF, codeTestError, errors.WithMsg("test"))
 	fmt.Println(err.Error())
-	fmt.Println(errors.Code(err))
 	fmt.Println(errors.Msg(err))
+	fmt.Println(errors.MsgOrDefault(io.EOF, "default error message"))
 }
+
 ```
 
 ### 👥 Contributing

README.md

@@ -1,4 +1,4 @@
-# 🔧 Errors
+# 🧯 Errors
 
 [![Go Doc](_icons/godoc.svg)](https://pkg.go.dev/github.com/FishGoddess/errors)
 [![License](_icons/license.svg)](https://opensource.org/licenses/MIT)
@@ -61,9 +61,10 @@ func main() {
 	// Use WithMsg to carry a message.
 	err = errors.Wrap(io.EOF, codeTestError, errors.WithMsg("test"))
 	fmt.Println(err.Error())
-	fmt.Println(errors.Code(err))
 	fmt.Println(errors.Msg(err))
+	fmt.Println(errors.MsgOrDefault(io.EOF, "default error message"))
 }
+
 ```
 
 ### 👥 贡献者

_examples/basic.go

@@ -47,6 +47,6 @@ func main() {
 	// Use WithMsg to carry a message.
 	err = errors.Wrap(io.EOF, codeTestError, errors.WithMsg("test"))
 	fmt.Println(err.Error())
-	fmt.Println(errors.Code(err))
 	fmt.Println(errors.Msg(err))
+	fmt.Println(errors.MsgOrDefault(io.EOF, "default error message"))
 }

_icons/coverage.svg

@@ -1,4 +1,4 @@
-// Copyright 2022 FishGoddess. All rights reserved.
+// Copyright 2023 FishGoddess. All rights reserved.
 // Use of this source code is governed by a MIT style
 // license that can be found in the LICENSE file.
 
@@ -9,140 +9,12 @@ import (
 	"fmt"
 )
 
-const (
-	codeNil     = 0
-	codeUnknown = 1
-)
-
-const (
-	nilString = "<nil>"
-)
-
-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)
-	}
-)
-
-// Error wraps err with some information.
-type Error struct {
-	err error
-
-	code int32
-	msg  string
-}
-
-func (e *Error) Error() string {
-	if e == nil || e.err == nil {
-		return nilString
-	}
-
-	return FormatError(e)
-}
-
-func (e *Error) String() string {
-	if e == nil || e.err == nil {
-		return nilString
-	}
-
-	return FormatString(e)
-}
-
-// Is returns if e has the same type of target.
-func (e *Error) Is(target error) bool {
-	if e == nil {
-		return e == target
-	}
-
-	err, ok := target.(*Error)
-	if !ok {
-		return e.err == target
-	}
-
-	return e.code == err.code
-}
-
-// Unwrap returns err inside.
-func (e *Error) Unwrap() error {
-	if e == nil {
-		return nil
-	}
-
-	return e.err
-}
-
-// Wrap wraps err with code
-func Wrap(err error, code int32, opts ...Option) error {
-	if err == nil {
-		return nil
-	}
-
-	e := &Error{
-		err:  err,
-		code: code,
-		msg:  err.Error(),
-	}
-
-	applyOptions(e, opts)
-	return e
+// New returns a string error.
+func New(text string) error {
+	return errors.New(text)
 }
 
-// Unwrap returns if err is Error and its code == code, and the original error will be returned, too.
-func Unwrap(err error, code int32) (error, bool) {
-	for {
-		if err == nil {
-			return nil, false
-		}
-
-		e, ok := err.(*Error)
-		if !ok {
-			return err, false
-		}
-
-		if e.code == code {
-			return err, true
-		}
-
-		err = errors.Unwrap(err)
-	}
-}
-
-// Is returns if err is Error and its code == code.
-func Is(err error, code int32) bool {
-	_, ok := Unwrap(err, code)
-	return ok
-}
-
-// Code returns the code of err.
-func Code(err error) int32 {
-	if err == nil {
-		return codeNil
-	}
-
-	e, ok := err.(*Error)
-	if !ok {
-		return codeUnknown
-	}
-
-	return e.code
-}
-
-// Msg returns the msg of err.
-func Msg(err error) string {
-	if err == nil {
-		return nilString
-	}
-
-	e, ok := err.(*Error)
-	if !ok {
-		return err.Error()
-	}
-
-	return e.msg
+// NewF returns a string error.
+func NewF(text string, params ...interface{}) error {
+	return fmt.Errorf(text, params...)
 }

errors.go

@@ -1,71 +1,25 @@
-// Copyright 2022 FishGoddess. All rights reserved.
+// Copyright 2023 FishGoddess. All rights reserved.
 // Use of this source code is governed by a MIT style
 // license that can be found in the LICENSE file.
 
 package errors
 
 import (
-	"errors"
-	"io"
 	"testing"
 )
 
-// go test -v -cover -run=^TestError$
-func TestError(t *testing.T) {
-	code := int32(500)
-
-	err := Wrap(nil, code)
-	if err != nil {
-		t.Errorf("err %+v is wrong", err)
-	}
-
-	err = Wrap(errors.New("500"), code)
-	if e, ok := Unwrap(err, code); !ok || e.Error() != "500" {
-		t.Errorf("err %+v is wrong", err)
-	}
-}
-
-// go test -v -cover -run=^TestCode$
-func TestCode(t *testing.T) {
-	code := int32(500)
-
-	got := Code(nil)
-	if got != codeNil {
-		t.Errorf("got %d is wrong", got)
-	}
-
-	got = Code(Wrap(nil, code))
-	if got != codeNil {
-		t.Errorf("got %d is wrong", got)
-	}
-
-	got = Code(io.EOF)
-	if got != codeUnknown {
-		t.Errorf("got %d is wrong", got)
-	}
-
-	got = Code(Wrap(errors.New("500"), code))
-	if got != code {
-		t.Errorf("got %d is wrong", got)
+// go test -v -cover -run=^TestNew$
+func TestNew(t *testing.T) {
+	err := New("test")
+	if err.Error() != "test" {
+		t.Errorf("err.Error() %s != 'test'", err.Error())
 	}
 }
 
-// go test -v -cover -run=^TestMsg$
-func TestMsg(t *testing.T) {
-	code := int32(500)
-
-	msg := Msg(Wrap(nil, code))
-	if msg != nilString {
-		t.Errorf("msg %s is wrong", msg)
-	}
-
-	msg = Msg(Wrap(errors.New("500"), code))
-	if msg != "500" {
-		t.Errorf("msg %s is wrong", msg)
-	}
-
-	msg = Msg(Wrap(errors.New("500"), code, WithMsg("internal")))
-	if msg != "internal" {
-		t.Errorf("msg %s is wrong", msg)
+// go test -v -cover -run=^TestNewF$
+func TestNewF(t *testing.T) {
+	err := NewF("test %d %.2f", 123, 3.14)
+	if err.Error() != "test 123 3.14" {
+		t.Errorf("err.Error() %s != 'test 123 3.14'", err.Error())
 	}
 }

errors_test.go

@@ -0,0 +1,56 @@
+// Copyright 2023 FishGoddess. All rights reserved.
+// Use of this source code is governed by a MIT style
+// license that can be found in the LICENSE file.
+
+package errors
+
+const (
+	codeTimeout      = 1000
+	codeNetworkError = 1100
+	codeDBError      = 1200
+)
+
+// Timeout returns a timeout error.
+func Timeout(err error, opts ...Option) error {
+	return Wrap(err, codeTimeout, opts...)
+}
+
+// IsTimeout if err is timeout.
+func IsTimeout(err error) bool {
+	return Is(err, codeTimeout)
+}
+
+// UnwrapTimeout if err is timeout.
+func UnwrapTimeout(err error) (error, bool) {
+	return Unwrap(err, codeTimeout)
+}
+
+// NetworkError returns a network error.
+func NetworkError(err error, opts ...Option) error {
+	return Wrap(err, codeNetworkError, opts...)
+}
+
+// IsNetworkError if err is network error.
+func IsNetworkError(err error) bool {
+	return Is(err, codeNetworkError)
+}
+
+// UnwrapNetworkError if err is network error.
+func UnwrapNetworkError(err error) (error, bool) {
+	return Unwrap(err, codeNetworkError)
+}
+
+// DBError returns a db error.
+func DBError(err error, opts ...Option) error {
+	return Wrap(err, codeDBError, opts...)
+}
+
+// IsDBError if err is db error.
+func IsDBError(err error) bool {
+	return Is(err, codeDBError)
+}
+
+// UnwrapDBError if err is db error.
+func UnwrapDBError(err error) (error, bool) {
+	return Unwrap(err, codeDBError)
+}