errors

README

Errors

errors package serve to build an arbitrary long error chain in order to capture errors returned from nested service calls.

errors package contains the custom Go error interface implementation, Error. You use the Error interface to ** wrap** two errors in a containing error as well as to test recursively if a given error contains some other error.

Documentation

Index

• Variables
• func Contains(e1 error, e2 error) bool
• func Wrap(wrapper error, err error) error
• type Error
  • func New(text string) Error

Variables

var (
	// ErrUnsupportedContentType indicates unacceptable or lack of Content-Type
	ErrUnsupportedContentType = New("unsupported content type")

	// ErrInvalidQueryParams indicates invalid query parameters
	ErrInvalidQueryParams = New("invalid query parameters")

	// ErrNotFoundParam indicates that the parameter was not found in the query
	ErrNotFoundParam = New("parameter not found in the query")

	// ErrMalformedEntity indicates a malformed entity specification
	ErrMalformedEntity = New("malformed entity specification")

	// 	ErrEntityNameNotFound indicates that the entity name was not found
	ErrEntityNameNotFound = New("malformed entity specificiation. name not found")

	// ErrBackendNotFound indicates that the backend field was not found
	ErrBackendNotFound = New("malformed entity specification. backend field is expected")

	// ErrInvalidBackend indicates a malformed entity specification on backend field
	ErrInvalidBackend = New("malformed entity specification. backend field is invalid")

	// ErrConfigFieldNotFound indicates that configuration field was not found
	ErrConfigFieldNotFound = New("malformed entity specification. configuration field is expected")

	// ErrExporterFieldNotFound indicates that exporter field was not found
	ErrExporterFieldNotFound = New("malformed entity specification. exporter field is expected on configuration field")

	// ErrAuthFieldNotFound indicates that authentication field was not found on configuration field
	ErrAuthFieldNotFound = New("malformed entity specification. authentication fields are expected on configuration field")

	// ErrAuthTypeNotFound indicates that authentication type field was not found on the authentication field
	ErrAuthTypeNotFound = New("malformed entity specification: authentication type field is expected on configuration field")

	// ErrInvalidAuthType indicates invalid authentication type
	ErrInvalidAuthType = New("malformed entity specification. type key on authentication field is invalid")

	// ErrPasswordNotFound indicates that password key was not found
	ErrPasswordNotFound = New("malformed entity specification. password key is expected on authentication field")

	// ErrEndPointNotFound indicates that endpoint field was not found on exporter field for otlp backend
	ErrEndpointNotFound = New("malformed entity specification. endpoint field is expected on exporter field")

	// ErrInvalidEndpoint indicates that endpoint field is not valid
	ErrInvalidEndpoint = New("malformed entity specification. endpoint field is invalid")

	// ErrInvalidPasswordType indicates invalid password key on authentication field
	ErrInvalidPasswordType = New("malformed entity specification. password key on authentication field is invalid")

	// ErrInvalidUsernameType indicates invalid username key on authentication field
	ErrInvalidUsernameType = New("malformed entity specification. username key on authentication field is invalid")

	// ErrRemoteHostNotFound indicates that remote host field was not found
	ErrRemoteHostNotFound = New("malformed entity specification. remote host is expected on exporter field")

	// ErrInvalidRemoteHost indicates that remote host field is invalid
	ErrInvalidRemoteHost = New("malformed entity specification. remote host type is invalid")

	// ErrNotFound indicates a non-existent entity request.
	ErrNotFound = New("non-existent entity")

	// ErrConflict indicates that entity already exists.
	ErrConflict = New("entity already exists")

	// ErrUpdateEntity indicates error in updating entity or entities
	ErrUpdateEntity = New("update entity failed")

	// ErrViewEntity indicates error in viewing entity or entities
	ErrViewEntity = New("view entity failed")

	// ErrUnauthorizedAccess indicates missing or invalid credentials provided
	// when accessing a protected resource.
	ErrUnauthorizedAccess = New("missing or invalid credentials provided")

	// ErrScanMetadata indicates problem with metadata in db.
	ErrScanMetadata = New("failed to scan metadata")

	// ErrSelectEntity indicates error while reading entity from database
	ErrSelectEntity = New("select entity from db error")
)

Functions

func Contains

func Contains(e1 error, e2 error) bool

Contains inspects if e2 error is contained in any layer of e1 error

func Wrap

func Wrap(wrapper error, err error) error

Wrap returns an Error that wrap err with wrapper

Types

type Error

type Error interface {

	// Error implements the error interface.
	Error() string

	// Msg returns error message
	Msg() string

	// Err returns wrapped error
	Err() Error
}

Error specifies an API that must be fulfilled by error type

func New

func New(text string) Error

New returns an Error that formats as the given text.