Documentation
¶
Overview ¶
Package gerror provides rich functionalities to manipulate errors.
For maintainers, please very note that, this package is quite a basic package, which SHOULD NOT import extra packages except standard packages and internal packages, to avoid cycle imports.
Index ¶
- func Cause(err error) error
- func Code(err error) gcode.Code
- func Current(err error) error
- func Equal(err, target error) bool
- func HasCode(err error, code gcode.Code) bool
- func HasError(err, target error) bool
- func HasStack(err error) bool
- func Is(err, target error) bool
- func New(text string) error
- func NewCode(code gcode.Code, text ...string) error
- func NewCodeSkip(code gcode.Code, skip int, text ...string) error
- func NewCodeSkipf(code gcode.Code, skip int, format string, args ...interface{}) error
- func NewCodef(code gcode.Code, format string, args ...interface{}) error
- func NewOption(option Option) error
- func NewSkip(skip int, text string) error
- func NewSkipf(skip int, format string, args ...interface{}) error
- func NewWithOption(option Option) error
- func Newf(format string, args ...interface{}) error
- func Stack(err error) string
- func Unwrap(err error) error
- func Wrap(err error, text string) error
- func WrapCode(code gcode.Code, err error, text ...string) error
- func WrapCodeSkip(code gcode.Code, skip int, err error, text ...string) error
- func WrapCodeSkipf(code gcode.Code, skip int, err error, format string, args ...interface{}) error
- func WrapCodef(code gcode.Code, err error, format string, args ...interface{}) error
- func WrapSkip(skip int, err error, text string) error
- func WrapSkipf(skip int, err error, format string, args ...interface{}) error
- func Wrapf(err error, format string, args ...interface{}) error
- type Error
- func (err *Error) Cause() error
- func (err *Error) Code() gcode.Code
- func (err *Error) Current() error
- func (err *Error) Equal(target error) bool
- func (err *Error) Error() string
- func (err *Error) Format(s fmt.State, verb rune)
- func (err *Error) Is(target error) bool
- func (err Error) MarshalJSON() ([]byte, error)
- func (err *Error) SetCode(code gcode.Code)
- func (err *Error) Stack() string
- func (err *Error) Unwrap() error
- type ICause
- type ICode
- type ICurrent
- type IEqual
- type IIs
- type IStack
- type IUnwrap
- type Option
Examples ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Code ¶
Code returns the error code of `current error`. It returns `CodeNil` if it has no error code neither it does not implement interface Code.
func Current ¶
Current creates and returns the current level error. It returns nil if current level error is nil.
func Equal ¶ added in v2.1.0
Equal reports whether current error `err` equals to error `target`. Please note that, in default comparison logic for `Error`, the errors are considered the same if both the `code` and `text` of them are the same.
Example ¶
package main
import (
"errors"
"fmt"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
)
func main() {
err1 := errors.New("permission denied")
err2 := gerror.New("permission denied")
err3 := gerror.NewCode(gcode.CodeNotAuthorized, "permission denied")
fmt.Println(gerror.Equal(err1, err2))
fmt.Println(gerror.Equal(err2, err3))
}
Output: true false
func HasCode ¶ added in v2.1.3
HasCode checks and reports whether `err` has `code` in its chaining errors.
func Is ¶ added in v2.1.0
Is reports whether current error `err` has error `target` in its chaining errors. It is just for implements for stdlib errors.Is from Go version 1.17.
Example ¶
package main
import (
"errors"
"fmt"
"github.com/gogf/gf/v2/errors/gerror"
)
func main() {
err1 := errors.New("permission denied")
err2 := gerror.Wrap(err1, "operation failed")
fmt.Println(gerror.Is(err1, err1))
fmt.Println(gerror.Is(err2, err2))
fmt.Println(gerror.Is(err2, err1))
fmt.Println(gerror.Is(err1, err2))
}
Output: false true true false
func NewCode ¶
NewCode creates and returns an error that has error code and given text.
Example ¶
package main
import (
"fmt"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
)
func main() {
err := gerror.NewCode(gcode.New(10000, "", nil), "My Error")
fmt.Println(err.Error())
fmt.Println(gerror.Code(err))
}
Output: My Error 10000
func NewCodeSkip ¶
NewCodeSkip creates and returns an error which has error code and is formatted from given text. The parameter `skip` specifies the stack callers skipped amount.
func NewCodeSkipf ¶
NewCodeSkipf returns an error that has error code and formats as the given format and args. The parameter `skip` specifies the stack callers skipped amount.
func NewCodef ¶
NewCodef returns an error that has error code and formats as the given format and args.
Example ¶
package main
import (
"fmt"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
)
func main() {
err := gerror.NewCodef(gcode.New(10000, "", nil), "It's %s", "My Error")
fmt.Println(err.Error())
fmt.Println(gerror.Code(err).Code())
}
Output: It's My Error 10000
func NewOption ¶
NewOption creates and returns a custom error with Option. Deprecated: use NewWithOption instead.
func NewSkip ¶
NewSkip creates and returns an error which is formatted from given text. The parameter `skip` specifies the stack callers skipped amount.
func NewSkipf ¶
NewSkipf returns an error that formats as the given format and args. The parameter `skip` specifies the stack callers skipped amount.
func NewWithOption ¶ added in v2.6.0
NewWithOption creates and returns a custom error with Option. It is the senior usage for creating error, which is often used internally in framework.
func Stack ¶
Stack returns the stack callers as string. It returns the error string directly if the `err` does not support stacks.
func Unwrap ¶ added in v2.1.0
Unwrap returns the next level error. It returns nil if current level error or the next level error is nil.
func Wrap ¶
Wrap wraps error with text. It returns nil if given err is nil. Note that it does not lose the error code of wrapped error, as it inherits the error code from it.
func WrapCode ¶
WrapCode wraps error with code and text. It returns nil if given err is nil.
Example ¶
package main
import (
"errors"
"fmt"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
)
func main() {
err1 := errors.New("permission denied")
err2 := gerror.WrapCode(gcode.New(10000, "", nil), err1, "Custom Error")
fmt.Println(err2.Error())
fmt.Println(gerror.Code(err2).Code())
}
Output: Custom Error: permission denied 10000
func WrapCodeSkip ¶
WrapCodeSkip wraps error with code and text. It returns nil if given err is nil. The parameter `skip` specifies the stack callers skipped amount.
func WrapCodeSkipf ¶
WrapCodeSkipf wraps error with code and text that is formatted with given format and args. It returns nil if given err is nil. The parameter `skip` specifies the stack callers skipped amount.
func WrapCodef ¶
WrapCodef wraps error with code and format specifier. It returns nil if given `err` is nil.
Example ¶
package main
import (
"errors"
"fmt"
"github.com/gogf/gf/v2/errors/gcode"
"github.com/gogf/gf/v2/errors/gerror"
)
func main() {
err1 := errors.New("permission denied")
err2 := gerror.WrapCodef(gcode.New(10000, "", nil), err1, "It's %s", "Custom Error")
fmt.Println(err2.Error())
fmt.Println(gerror.Code(err2).Code())
}
Output: It's Custom Error: permission denied 10000
func WrapSkip ¶
WrapSkip wraps error with text. It returns nil if given err is nil. The parameter `skip` specifies the stack callers skipped amount. Note that it does not lose the error code of wrapped error, as it inherits the error code from it.
func WrapSkipf ¶
WrapSkipf wraps error with text that is formatted with given format and args. It returns nil if given err is nil. The parameter `skip` specifies the stack callers skipped amount. Note that it does not lose the error code of wrapped error, as it inherits the error code from it.
Types ¶
type Error ¶
type Error struct {
// contains filtered or unexported fields
}
Error is custom error for additional features.
func (*Error) Current ¶
Current creates and returns the current level error. It returns nil if current level error is nil.
func (*Error) Equal ¶ added in v2.1.0
Equal reports whether current error `err` equals to error `target`. Please note that, in default comparison for `Error`, the errors are considered the same if both the `code` and `text` of them are the same.
func (*Error) Format ¶
Format formats the frame according to the fmt.Formatter interface.
%v, %s : Print all the error string; %-v, %-s : Print current level error string; %+s : Print full stack error list; %+v : Print the error string and full stack error list
func (*Error) Is ¶ added in v2.1.0
Is reports whether current error `err` has error `target` in its chaining errors. It is just for implements for stdlib errors.Is from Go version 1.17.
func (Error) MarshalJSON ¶
MarshalJSON implements the interface MarshalJSON for json.Marshal. Note that do not use pointer as its receiver here.
Source Files