README
¶
commonerrors - tags for common causes of errors
Install:
go get github.com/muir/commonerrors
Idea
Commonerrors is a collection of error tags.
It offers:
- UsageError
- EnvironmentError
- ConfigurationError
- ProgrammerError
- LibraryError
Basis
Right now, this package is based on github.com/pkg/errors. That package's support of WithStack is a bit broken so the base error package could change in the future.
Documentation
¶
Index ¶
- func ConfigurationError(err error) error
- func EnvironmentError(err error) error
- func IsConfigurationError(err error) bool
- func IsEnvironmentError(err error) bool
- func IsLibraryError(err error) bool
- func IsProgrammerError(err error) bool
- func IsUsageError(err error) bool
- func IsValidationError(err error) bool
- func LibraryError(err error) error
- func ProgrammerError(err error) error
- func UsageError(err error) error
- func ValidationError(err error) error
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ConfigurationError ¶
ConfigurationError annotates an error as being a configuration error (messed up flags/command invocation). When you have a configuration error, you should display the program configuration help text.
func EnvironmentError ¶
EnvironmentError annotates an error as being caused by an invalid environment variable. When you have an environment error, you may want to display appropriate help.
func IsConfigurationError ¶
func IsEnvironmentError ¶
func IsLibraryError ¶
func IsProgrammerError ¶
func IsUsageError ¶
func IsValidationError ¶
func LibraryError ¶
LibraryError annotates an error as being caused by a bug in an imported library. Library authors should annotate errors that shouldn't happen this way. If you see such an error, please submit a fix or at least raise an issue.
func ProgrammerError ¶
ProgrammerError annotates an error as being made by a user (importer) or a published package.
func UsageError ¶
UsageError annotates an error as being a usage error (messed up flags/command invocation). When you have a usage error, you should display the program usage help text.
func ValidationError ¶
ValidationError annotates an error as being caused by an invalid value.
Types ¶
This section is empty.
Source Files