errorKit

Documentation

Index

• Variables
• func Newf(format string, args ...interface{}) error
• func NewfWithSkip(skip int, format string, args ...interface{}) error
• func Wrapf(err error, format string, args ...interface{}) error

Variables

var (
	// Is 作用: 传参err 的错误链中，是否存在和 传参target 匹配的error实例？(reports whether any error in err's tree matches target.)
	/*
		Deprecated: Use errors.Is() instead.

		PS: 支持第三方依赖 "github.com/gogf/gf/v2/errors/gerror".

		@param target 可以为nil
	*/
	Is func(err, target error) bool = errors.Is

	// As
	/*
		Deprecated: Use errors.As() instead.

		!!!:
		对于传参target，
		(1) 如果 Error() 绑定在结构体上（receiver为"值类型"），需要 1个 '&';
		(2) 如果 Error() 绑定在结构体指针上（receiver为"指针类型"），需要 2个 '&'.

		查找 传参err 的错误链中与 传参target 匹配的第一个错误，(1) 如果找到，则 将 传参target 设置为该错误值 && 返回true;
														(2) 否则 返回false.
		finds the first error in err's tree that matches target, and if one is found, sets
		target to that error value and returns true. Otherwise, it returns false.

		PS: 支持第三方依赖 "github.com/gogf/gf/v2/errors/gerror".

		@param target 	(1) 不能为nil，否则会 panic
						(2) 必须是指针类型，否则会 panic
	*/
	As func(err error, target any) bool = errors.As

	// Equal 错误比较
	Equal func(err, target error) bool = gerror.Equal

	// HasStack 判断错误是否带堆栈
	HasStack func(err error) bool = gerror.HasStack

	// Stack 获取堆栈信息
	Stack func(err error) string = gerror.Stack

	// Current 获取当前error
	Current func(err error) error = gerror.Current

	// Unwrap 获取层级错误的下一级错误error接口对象(当下一层级不存在时，返回nil)
	Unwrap func(err error) error = gerror.Unwrap

	// Cause 获取根错误error
	Cause func(err error) error = gerror.Cause
)

var (
	// Simplef 使用 err.Error() 或 "%v" 时，不会附带调用此函数的调用方的名称和文件信息.
	Simplef = gerror.Newf
)

Functions

func Newf

func Newf(format string, args ...interface{}) error

Newf 用于创建一个自定义错误信息的error对象，并包含堆栈信息.

@param format !!!: 类似于fmt.Errorf()， (1) 不应该首字母大写;

(2) 不应该以标点符号结尾.

func NewfWithSkip

func NewfWithSkip(skip int, format string, args ...interface{}) error

NewfWithSkip 用于创建一个自定义错误信息的error对象，并且忽略部分堆栈信息（按照当前调用方法位置往上忽略）。高级功能，一般开发者很少用得到.

@param skip (1) >=0
			(2) 0: 等价于 Newf || Newf
			(2) 1: 跳过1层（e.g. assert工具类）

func Wrapf

func Wrapf(err error, format string, args ...interface{}) error

Wrapf 用于包裹其他错误error对象，构造成多级的错误信息，包含堆栈信息.

@param format !!!: 类似于fmt.Errorf()， (1) 不应该首字母大写;

(2) 不应该以标点符号结尾.