def

package

v1.5.4 Latest Latest Go to latest Published: Jan 27, 2026 License: MIT Imports: 1 Imported by: 37

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/muidea/magicCommon

Links

Open Source Insights

Documentation ¶

Index ¶

Constants
type Code
type Error
- func NewError(errorCode Code, errorMessage string) *Error
- func (e Error) Error() string
type Result
- func NewResult() *Result
- func NewSuccessResult() *Result
type ResultWithError

Constants ¶

View Source

const (
	Success = iota
	// UnKnownError 未知错误
	UnKnownError
	// NotFound 未找到
	NotFound
	// InvalidParam 无效参数
	InvalidParameter
	// IllegalParam 非法参数
	IllegalParam
	// InvalidAuthority 非法授权
	InvalidAuthority
	// Unexpected 意外错误
	Unexpected
	// Duplicated 重复
	Duplicated
	// DatabaseError 数据库错误
	DatabaseError
	// Timeout 超时
	Timeout
	// NetworkError 网络错误
	NetworkError
	// Unauthorized 未授权
	Unauthorized
	// Forbidden 禁止访问
	Forbidden
	// ResourceExhausted 资源耗尽
	ResourceExhausted
	// TooManyRequests 请求过多
	TooManyRequests
	// ServiceUnavailable 服务不可用
	ServiceUnavailable
	// NotImplemented 未实现
	NotImplemented
	// BadGateway 网关错误
	BadGateway
	// DataCorrupted 数据损坏
	DataCorrupted
	// VersionConflict 版本冲突
	VersionConflict
	// ExternalServiceError 外部服务错误
	ExternalServiceError
	// InvalidOperation 无效操作
	InvalidOperation
	// PermissionDenied 权限不足
	PermissionDenied
)

Variables ¶

This section is empty.

Functions ¶

This section is empty.

Types ¶

type Code ¶ added in v1.4.0

type Code int

type Error ¶ added in v1.4.0

type Error struct {
	Code    Code   `json:"code"`
	Message string `json:"message"`
}

func NewError ¶ added in v1.3.36

func NewError(errorCode Code, errorMessage string) *Error

func (Error) Error ¶ added in v1.4.0

func (e Error) Error() string

type Result ¶

type Result struct {
	Error *Error `json:"error"`
}

func NewResult ¶ added in v1.4.0

func NewResult() *Result

func NewSuccessResult ¶ added in v1.5.4

func NewSuccessResult() *Result

NewSuccessResult 创建一个成功的 Result（无错误）

func (*Result) Fail ¶

func (s *Result) Fail() bool

Fail 失败

func (*Result) GetError ¶ added in v1.5.4

func (r *Result) GetError() *Error

GetError 返回错误指针，便于实现 ResultWithError 接口

func (*Result) SetError ¶ added in v1.5.4

func (r *Result) SetError(err *Error)

SetError 设置错误

func (*Result) Success ¶

func (s *Result) Success() bool

Success 成功

type ResultWithError ¶ added in v1.5.4

type ResultWithError interface {
	GetError() *Error
}

ResultWithError 表示包含错误的结果接口

Source Files ¶

View all Source files

result.go

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL