errs

Documentation

Index

• Variables
• type Err
  • func New(internalInfo Info, userMessage ...interface{}) Err
  • func NewWithOpts(internalInfo Info, opts Opts, userMessage ...interface{}) Err
  • func Wrap(stdErr error, userMessage ...interface{}) Err
  • func WrapWithInfo(stdErr error, internalInfo Info, userMessage ...interface{}) Err
  • func WrapWithOpts(stdErr error, internalInfo Info, opts Opts, userMessage ...interface{}) Err
• type Info
• type Opts

Variables

var (
	DefaultUserMessage = "Oops! Something went wrong. Please try again."
	DefaultOpts        = Opts{
		OmitStack: false,
	}
)

Types

type Err

type Err interface {
	Stack() []byte
	Time() time.Time
	StandardError() error
	StandardErrorMessage() string
	UserMessage() string
	SetUserMessage(userMessage string)
	InternalInfo() Info
	LogString() string
}

func New

func New(internalInfo Info, userMessage ...interface{}) Err

func NewWithOpts

func NewWithOpts(internalInfo Info, opts Opts, userMessage ...interface{}) Err

func Wrap

func Wrap(stdErr error, userMessage ...interface{}) Err

func WrapWithInfo

func WrapWithInfo(stdErr error, internalInfo Info, userMessage ...interface{}) Err

func WrapWithOpts

func WrapWithOpts(stdErr error, internalInfo Info, opts Opts, userMessage ...interface{}) Err

type Info

type Info map[string]interface{}

type Opts

type Opts struct {
	OmitStack bool
}