errors

Documentation

Overview

Package errors provides an Error interface that includes the component name with the underlying error.

Index

• Constants
• func Component(err error) string
• func IsPermanent(err error) bool
• func New(component string, err interface{}) error
• func NewPermanent(component string, err interface{}) error

Constants

const DefaultComp = "web test launcher"

DefaultComp is the default component name used when no other component specified.

Functions

func Component

func Component(err error) string

Component returns err.Component() if err implements it, otherwise it returns DefaultComp. Component is intended for grouping error messages by source.

func IsPermanent

func IsPermanent(err error) bool

IsPermanent returns err.Permanent() if err implements it, otherwise it returns false. IsPermanent is intended for preventing retries when errors occur that are unlikely to go away.

func New

func New(component string, err interface{}) error

New returns an error, e, such that:

Permanent(e) is false
If Component(err) is not DefaultComp, Component(e) is Component(err)
Else If component is "", Component(e) is DefaultComp
Else Component(e) is component.

func NewPermanent

func NewPermanent(component string, err interface{}) error

NewPermanent returns an error, e, such that:

Permanent(e) is true
If Component(err) is not DefaultComp, Component(e) is Component(err)
Else If component is "", Component(e) is DefaultComp
Else Component(e) is component.