v2ray-core/common/errors/errors.go

109 lines
2.0 KiB
Go

// Package errors is a drop-in replacement for Golang lib 'errors'.
package errors
import (
"fmt"
"v2ray.com/core/common/serial"
)
type hasInnerError interface {
// Inner returns the underlying error of this one.
Inner() error
}
type actionRequired interface {
ActionRequired() bool
}
// Error is an error object with underlying error.
type Error struct {
message string
inner error
actionRequired bool
}
// Error implements error.Error().
func (v Error) Error() string {
msg := v.message
if v.inner != nil {
msg += " > " + v.inner.Error()
}
return msg
}
// Inner implements hasInnerError.Inner()
func (v Error) Inner() error {
if v.inner == nil {
return nil
}
return v.inner
}
func (v Error) ActionRequired() bool {
return v.actionRequired
}
func (v Error) RequireUserAction() Error {
v.actionRequired = true
return v
}
func (v Error) Message(msg ...interface{}) Error {
return Error{
inner: v,
message: serial.Concat(msg...),
}
}
func (v Error) Format(format string, values ...interface{}) Error {
return v.Message(fmt.Sprintf(format, values...))
}
// New returns a new error object with message formed from given arguments.
func New(msg ...interface{}) Error {
return Error{
message: serial.Concat(msg...),
}
}
// Base returns an Error based on the given error.
func Base(err error) Error {
return Error{
inner: err,
}
}
func Format(format string, values ...interface{}) error {
return New(fmt.Sprintf(format, values...))
}
// Cause returns the root cause of this error.
func Cause(err error) error {
if err == nil {
return nil
}
for {
inner, ok := err.(hasInnerError)
if !ok || inner.Inner() == nil {
break
}
err = inner.Inner()
}
return err
}
func IsActionRequired(err error) bool {
for err != nil {
if ar, ok := err.(actionRequired); ok && ar.ActionRequired() {
return true
}
inner, ok := err.(hasInnerError)
if !ok || inner.Inner() == nil {
break
}
err = inner.Inner()
}
return false
}