gf/errors/gerror/gerror.go

// Copyright GoFrame gf Author(https://goframe.org). All Rights Reserved.
//
// This Source Code Form is subject to the terms of the MIT License.
// If a copy of the MIT was not distributed with this file,
// You can obtain one at https://github.com/gogf/gf.

// 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.
package gerror

import (
	"github.com/gogf/gf/v2/errors/gcode"
)

// IEqual is the interface for Equal feature.
type IEqual interface {
	error
	Equal(target error) bool
}

// ICode is the interface for Code feature.
type ICode interface {
	error
	Code() gcode.Code
}

// IStack is the interface for Stack feature.
type IStack interface {
	error
	Stack() string
}

// ICause is the interface for Cause feature.
type ICause interface {
	error
	Cause() error
}

// ICurrent is the interface for Current feature.
type ICurrent interface {
	error
	Current() error
}

// IUnwrap is the interface for Unwrap feature.
type IUnwrap interface {
	error
	Unwrap() error
}

// ITextArgs is the interface for Text and Args features.
// This interface is mainly used for i18n features, that needs text and args separately.
type ITextArgs interface {
	error
	Text() string
	Args() []any
}

const (
	// commaSeparatorSpace is the comma separator with space.
	commaSeparatorSpace = ", "
)