errors

package module
v2.0.1 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Jan 13, 2020 License: MIT Imports: 8 Imported by: 0

README

errors

Build Status GitHub tag (latest SemVer) GoDoc Go Report Card codecov

Attachable errors for golang dev (for go1.13+).

Import

import "github.com/hedzr/errors/v2"

Features

stdlib `errors' compatibilities
  • func As(err error, target interface{}) bool
  • func Is(err, target error) bool
  • func New(text string) error
  • func Unwrap(err error) error
pkg/errors compatibilities
  • func Wrap(err error, message string) error
  • func Cause(err error) error
  • func Cause1(err error) error
  • supports Stacktrace
    • in an error by Wrap(), stacktrace wrapped;
    • for your error, attached by WithStack(cause error);
error Container and sub-errors

Documentation

Overview

Package errors defines the generic error codes, nestable ExtErr object.

Index

Constants

View Source
const (
	// AppName const
	AppName = "errors"
	// Version const
	Version = "2.0.1"
	// VersionInt const
	VersionInt = 0x020001
)

Variables

This section is empty.

Functions

func As

func As(err error, target interface{}) bool

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.

func AttachTo

func AttachTo(container *withCauses, errs ...error)

AttachTo appends more errors into 'container' error container.

func CanAs

func CanAs(err interface{}) (ok bool)

CanAs tests if err is as-able

func CanAttach

func CanAttach(err interface{}) bool

CanAttach tests if err is attach-able

func CanCause

func CanCause(err interface{}) bool

CanCause tests if err is cause-able

func CanIs

func CanIs(err interface{}) (ok bool)

CanIs tests if err is is-able

func CanUnwrap

func CanUnwrap(err interface{}) (ok bool)

CanUnwrap tests if err is unwrap-able

func Cause

func Cause(err error) error

Cause returns the underlying cause of the error recursively, if possible. An error value has a cause if it implements the following interface:

type causer interface {
       Cause() error
}

If the error does not implement Cause, the original error will be returned. If the error is nil, nil will be returned without further investigation.

func Cause1

func Cause1(err error) error

Cause1 returns the underlying cause of the error, if possible. An error value has a cause if it implements the following interface:

type causer interface {
       Cause() error
}

If the error does not implement Cause, the original error will be returned. If the error is nil, nil will be returned without further investigation.

func ContainerIsEmpty

func ContainerIsEmpty(container error) bool

ContainerIsEmpty appends more errors into 'container' error container.

func DumpStacksAsString

func DumpStacksAsString(allRoutines bool) string

DumpStacksAsString returns stack tracing information like debug.PrintStack()

func Is

func Is(err, target error) bool

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 New

func New(message string, args ...interface{}) error

func NewContainer

func NewContainer(message string, args ...interface{}) *withCauses

NewContainer wraps a group of errors and msg as one and return it. The returned error object is a container to hold many sub-errors.

Examples:

func Unwrap

func Unwrap(err error) error

Unwrap returns the result of calling the Unwrap method on err, if err's type contains an Unwrap method returning error. Otherwise, Unwrap returns nil.

func WithCause

func WithCause(cause error, msg string) error

func WithStack

func WithStack(cause error) error

WithStack annotates err with a stack trace at the point WithStack was called. If err is nil, WithStack returns nil.

func Wrap

func Wrap(err error, message string, args ...interface{}) error

Wrap returns an error annotating err with a stack trace at the point Wrap is called, and the supplied message. If err is nil, Wrap returns nil.

Types

type Frame

type Frame uintptr

Frame represents a program counter inside a stack frame.

func (Frame) Format

func (f Frame) Format(s fmt.State, verb rune)

Format formats the frame according to the fmt.Formatter interface.

%s    source file
%d    source line
%n    function name
%v    equivalent to %s:%d

Format accepts flags that alter the printing of some verbs, as follows:

%+s   function name and path of source file relative to the compile time
      GOPATH separated by \n\t (<funcname>\n\t<path>)
%+v   equivalent to %+s:%d

type StackTrace

type StackTrace []Frame

StackTrace is stack of Frames from innermost (newest) to outermost (oldest).

func (StackTrace) Format

func (st StackTrace) Format(s fmt.State, verb rune)

Format formats the stack of Frames according to the fmt.Formatter interface.

%s	lists source files for each Frame in the stack
%v	lists the source file and line number for each Frame in the stack

Format accepts flags that alter the printing of some verbs, as follows:

%+v   Prints filename, function, and line number for each Frame in the stack.

Jump to

Keyboard shortcuts

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