Documentation ¶
Overview ¶
Package errors defines the generic error codes, nestable ExtErr object.
Index ¶
- Constants
- func As(err error, target interface{}) bool
- func Attach(err error, errs ...error)
- func CanAs(err error) (ok bool)
- func CanIs(err error) (ok bool)
- func CanRange(err error) (ok bool)
- func CanUnwrap(err error) (ok bool)
- func CanWalk(err error) (ok bool)
- func DumpStacksAsString(allRoutines bool) string
- func Equal(err error, code Code) bool
- func HasAttachedErrors(err error) (yes bool)
- func HasInnerErrors(err error) (yes bool)
- func HasWrappedError(err error) (yes bool)
- func Is(err, target error) bool
- func IsAny(err error, code ...Code) bool
- func IsBoth(err error, code ...Code) bool
- func Left(s string, length int) string
- func LeftPad(s string, pad rune, width int) string
- func Nest(err error, errs ...error)
- func Range(err error, fn func(err error) (stop bool))
- func Right(s string, length int) string
- func TextContains(err error, text string) bool
- func Unwrap(err error) error
- func Walk(err error, fn func(err error) (stop bool))
- type Code
- type CodedErr
- func (e *CodedErr) Attach(errors ...error) *CodedErr
- func (e *CodedErr) AttachIts(errors ...error)
- func (e *CodedErr) Code(code Code) *CodedErr
- func (e *CodedErr) Equal(code Code) bool
- func (e *CodedErr) EqualRecursive(code Code) bool
- func (e *CodedErr) Error() string
- func (e *CodedErr) Format(args ...interface{}) *CodedErr
- func (e *CodedErr) HasAttachedErrors() bool
- func (e *CodedErr) IsAny(code ...Code) bool
- func (e *CodedErr) IsBoth(code ...Code) bool
- func (e *CodedErr) Msg(msg string, args ...interface{}) *CodedErr
- func (e *CodedErr) Nest(errors ...error) *CodedErr
- func (e *CodedErr) NestIts(errors ...error)
- func (e *CodedErr) NoCannedError() bool
- func (e *CodedErr) Number() Code
- func (e *CodedErr) Template(tmpl string) *CodedErr
- type ExtErr
- func (e *ExtErr) As(target interface{}) bool
- func (e *ExtErr) Attach(errors ...error) *ExtErr
- func (e *ExtErr) AttachIts(errors ...error)
- func (e *ExtErr) Error() string
- func (e *ExtErr) Format(args ...interface{}) *ExtErr
- func (e *ExtErr) GetAttachedErrors() []error
- func (e *ExtErr) GetMsgString() string
- func (e *ExtErr) GetNestedError() *ExtErr
- func (e *ExtErr) GetTemplateString() string
- func (e *ExtErr) HasAttachedErrors() bool
- func (e *ExtErr) Is(err error) bool
- func (e *ExtErr) Msg(msg string, args ...interface{}) *ExtErr
- func (e *ExtErr) Nest(errors ...error) *ExtErr
- func (e *ExtErr) NestIts(errors ...error)
- func (e *ExtErr) NoCannedError() bool
- func (e *ExtErr) Range(fn func(err error) (stop bool))
- func (e *ExtErr) Template(tmpl string) *ExtErr
- func (e *ExtErr) Unwrap() error
- func (e *ExtErr) Walk(fn func(err error) (stop bool))
- type Ranged
- type Walkable
Examples ¶
Constants ¶
const ( // OK is returned on success. OK Code = 0 // Canceled indicates the operation was canceled (typically by the caller). Canceled Code = -1 // Unknown error. An example of where this error may be returned is // if a Status value received from another address space belongs to // an error-space that is not known in this address space. Also // errors raised by APIs that do not return enough error information // may be converted to this error. Unknown Code = -2 // InvalidArgument indicates client specified an invalid argument. // Note that this differs from FailedPrecondition. It indicates arguments // that are problematic regardless of the state of the system // (e.g., a malformed file name). InvalidArgument Code = -3 // DeadlineExceeded means operation expired before completion. // For operations that change the state of the system, this error may be // returned even if the operation has completed successfully. For // example, a successful response from a server could have been delayed // long enough for the deadline to expire. // // = HTTP 408 Timeout DeadlineExceeded Code = -4 // NotFound means some requested entity (e.g., file or directory) was // not found. // // = HTTP 404 NotFound Code = -5 // AlreadyExists means an attempt to create an entity failed because one // already exists. AlreadyExists Code = -6 // PermissionDenied indicates the caller does not have permission to // execute the specified operation. It must not be used for rejections // caused by exhausting some resource (use ResourceExhausted // instead for those errors). It must not be // used if the caller cannot be identified (use Unauthenticated // instead for those errors). PermissionDenied Code = -7 // ResourceExhausted indicates some resource has been exhausted, perhaps // a per-user quota, or perhaps the entire file system is out of space. ResourceExhausted Code = -8 // FailedPrecondition indicates operation was rejected because the // system is not in a state required for the operation's execution. // For example, directory to be deleted may be non-empty, an rmdir // operation is applied to a non-directory, etc. // // A litmus test that may help a service implementor in deciding // between FailedPrecondition, Aborted, and Unavailable: // (a) Use Unavailable if the client can retry just the failing call. // (b) Use Aborted if the client should retry at a higher-level // (e.g., restarting a read-modify-write sequence). // (c) Use FailedPrecondition if the client should not retry until // the system state has been explicitly fixed. E.g., if an "rmdir" // fails because the directory is non-empty, FailedPrecondition // should be returned since the client should not retry unless // they have first fixed up the directory by deleting files from it. // (d) Use FailedPrecondition if the client performs conditional // REST Get/Update/Delete on a resource and the resource on the // server does not match the condition. E.g., conflicting // read-modify-write on the same resource. FailedPrecondition Code = -9 // Aborted indicates the operation was aborted, typically due to a // concurrency issue like sequencer check failures, transaction aborts, // etc. // // See litmus test above for deciding between FailedPrecondition, // Aborted, and Unavailable. Aborted Code = -10 // OutOfRange means operation was attempted past the valid range. // E.g., seeking or reading past end of file. // // Unlike InvalidArgument, this error indicates a problem that may // be fixed if the system state changes. For example, a 32-bit file // system will generate InvalidArgument if asked to read at an // offset that is not in the range [0,2^32-1], but it will generate // OutOfRange if asked to read from an offset past the current // file size. // // There is a fair bit of overlap between FailedPrecondition and // OutOfRange. We recommend using OutOfRange (the more specific // error) when it applies so that callers who are iterating through // a space can easily look for an OutOfRange error to detect when // they are done. OutOfRange Code = -11 // Unimplemented indicates operation is not implemented or not // supported/enabled in this service. Unimplemented Code = -12 // Internal errors. Means some invariants expected by underlying // system has been broken. If you see one of these errors, // something is very broken. Internal Code = -13 // This is a most likely a transient condition and may be corrected // by retrying with a backoff. Note that it is not always safe to retry // non-idempotent operations. // // See litmus test above for deciding between FailedPrecondition, // Aborted, and Unavailable. Unavailable Code = -14 // DataLoss indicates unrecoverable data loss or corruption. DataLoss Code = -15 // Unauthenticated indicates the request does not have valid // authentication credentials for the operation. // // = HTTP 401 Unauthorized Unauthenticated Code = -16 // RateLimited indicates some flow control algorithm is running and applied. // = HTTP Code 429 RateLimited = -17 // BadRequest generates a 400 error. // = HTTP 400 BadRequest = -18 // Conflict generates a 409 error. // = hTTP 409 Conflict = -19 // Forbidden generates a 403 error. Forbidden = -20 // InternalServerError generates a 500 error. InternalServerError = -21 // MethodNotAllowed generates a 405 error. MethodNotAllowed = -22 // MinErrorCode is the lower bound MinErrorCode = -1000 )
const ( // AppName const AppName = "errors" // Version const Version = "1.1.18" // VersionInt const VersionInt = 0x010118 )
Variables ¶
This section is empty.
Functions ¶
func As ¶ added in v1.1.0
As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true.
The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.
An error matches target if the error's concrete value is assignable to the value pointed to by target, or if the error has a method As(interface{}) bool such that As(target) returns true. In the latter case, the As method is responsible for setting target.
As will panic if target is not a non-nil pointer to either a type that implements error, or to any interface type. As returns false if err is nil.
Example ¶
package main import ( "fmt" "github.com/hedzr/errors" "os" ) func main() { if _, err := os.Open("non-existing"); err != nil { var pathError *os.PathError if errors.As(err, &pathError) { fmt.Println("Failed at path:", pathError.Path) } else { fmt.Println(err) } } }
Output: Failed at path: non-existing
func DumpStacksAsString ¶ added in v1.1.11
DumpStacksAsString returns stack tracing information like debug.PrintStack()
func HasAttachedErrors ¶ added in v1.1.11
HasAttachedErrors detects if attached errors present
func HasInnerErrors ¶ added in v1.1.11
HasInnerErrors detects if nested or attached errors present
func HasWrappedError ¶ added in v1.1.11
HasWrappedError detects if nested or wrapped errors present
nested error: ExtErr.inner wrapped error: fmt.Errorf("... %w ...", err)
func Is ¶ added in v1.1.0
Is reports whether any error in err's chain matches target.
The chain consists of err itself followed by the sequence of errors obtained by repeatedly calling Unwrap.
An error is considered to match a target if it is equal to that target or if it implements a method Is(error) bool such that Is(target) returns true.
func Left ¶ added in v1.1.8
Left returns the left `length` substring of `s`. Left returns the whole source string `s` if its length is larger than `length`
Left("12345",3) => "123"
func LeftPad ¶ added in v1.1.8
LeftPad adds the leading char `pad` to `s`, and truncate it to the length `width`.
LeftPad("89", '0', 6) => "000089"
LeftPad returns an empty string "" if width is negative or zero. LeftPad returns the source string `s` if its length is larger than `width`.
func Right ¶ added in v1.1.8
Right returns the right `length` substring of `s`. Right returns the whole source string `s` if its length is larger than `length`
Right("12345",3) => "345"
func TextContains ¶ added in v1.1.11
TextContains test if a text fragment is included by err
Types ¶
type Code ¶
type Code int32
A Code is an signed 32-bit error code copied from gRPC spec but negatived.
type CodedErr ¶
type CodedErr struct { ExtErr // contains filtered or unexported fields }
CodedErr adds a error code
func NewCodedError ¶ added in v1.1.0
NewCodedError error object with nested errors
func (*CodedErr) Attach ¶ added in v1.1.0
Attach attaches the nested errors into CodedErr
Note that `ExtErr.Template()` had been overridden here
func (*CodedErr) EqualRecursive ¶ added in v1.1.8
EqualRecursive compares with code
func (*CodedErr) Format ¶ added in v1.1.1
Format compiles the final msg with string template and args
Note that `ExtErr.Template()` had been overridden here
func (*CodedErr) HasAttachedErrors ¶ added in v1.1.11
HasAttachedErrors tests if any errors attached (nor nested) to `e` or not
func (*CodedErr) Msg ¶ added in v1.1.0
Msg encodes a formattable msg with args into ExtErr
Note that `ExtErr.Template()` had been overridden here
func (*CodedErr) Nest ¶ added in v1.1.0
Nest attaches the nested errors into CodedErr
Note that `ExtErr.Template()` had been overridden here
func (*CodedErr) NoCannedError ¶ added in v1.1.9
NoCannedError detects mqttError object is not an error or not an canned-error (inners is empty)
type ExtErr ¶
type ExtErr struct {
// contains filtered or unexported fields
}
ExtErr is a nestable error object
func NewTemplate ¶ added in v1.1.1
NewTemplate ExtErr error object with string template and allows attach more nested errors
func NewWithError ¶
NewWithError ExtErr error object with nested errors
func Wrap ¶ added in v1.1.15
Wrap attaches an error object `err` into ExtErr.
With go official model, the behavior is: fmt.Sprintf("...%w...", err) In our model, `err` will be attached/wrapped into an ExtErr object.
func (*ExtErr) As ¶ added in v1.1.3
As finds the first error in err's chain that matches target, and if so, sets target to that error value and returns true.
func (*ExtErr) GetAttachedErrors ¶ added in v1.1.11
GetAttachedErrors returns e.errs member (attached errors)
func (*ExtErr) GetMsgString ¶ added in v1.1.8
GetMsgString returns e.msg member
func (*ExtErr) GetNestedError ¶ added in v1.1.11
GetNestedError returns e.inner member (nested errors)
func (*ExtErr) GetTemplateString ¶ added in v1.1.8
GetTemplateString returns e.tmpl member
func (*ExtErr) HasAttachedErrors ¶ added in v1.1.11
HasAttachedErrors tests if any errors attached (nor nested) to `e` or not
func (*ExtErr) NoCannedError ¶ added in v1.1.9
NoCannedError detects mqttError object is not an error or not an canned-error (inners is empty)
func (*ExtErr) Template ¶ added in v1.1.1
Template setup a string format template. Coder could compile the error object with formatting args later.