errorx

Documentation

Index

• Constants
• func IsAlreadyExistsError(e error) bool
• func IsFailedPreconditionError(e error) bool
• func IsInternalError(e error) bool
• func IsInvalidArgumentError(e error) bool
• func IsNotFoundError(e error) bool
• func IsOutOfRange(e error) bool
• func IsPermissionDeniedError(e error) bool
• func IsUnauthenticatedError(e error) bool
• func IsUnimplemented(e error) bool
• func PanicsWithCliniaError(t *testing.T, expected CliniaError, f func())
• type CliniaError
  • func AlreadyExistsErrorf(format string, args ...interface{}) CliniaError
  • func FailedPreconditionErrorf(format string, args ...interface{}) CliniaError
  • func InternalErrorf(format string, args ...interface{}) CliniaError
  • func InvalidArgumentErrorf(format string, args ...interface{}) CliniaError
  • func IsCliniaError(e error) (*CliniaError, bool)
  • func NewAlreadyExistsError(message string) CliniaError
  • func NewCliniaErrorFromMessage(msg string) (*CliniaError, error)
  • func NewEnumOutOfRangeError(actual string, expectedOneOf []string, enumName string) CliniaError
  • func NewFailedPreconditionError(message string) CliniaError
  • func NewMultipleOutOfRangeError(actual []string, expectedOneOf []string) CliniaError
  • func NewNotFoundError(msg string, err error) CliniaError
  • func NewSingleOutOfRangeError(actual string, expectedOneOf []string) CliniaError
  • func NotFoundErrorf(format string, args ...interface{}) CliniaError
  • func OutOfRangeErrorf(format string, args ...interface{}) CliniaError
  • func PermissionDeniedErrorf(format string, args ...interface{}) CliniaError
  • func UnauthenticatedErrorf(format string, args ...interface{}) CliniaError
  • func UnimplementedErrorf(format string, args ...interface{}) CliniaError
  • func (e CliniaError) Error() string
  • func (c *CliniaError) WithDetails(details ...CliniaError) CliniaError
• type CliniaRetryableError
  • func NewInternalError(e error) CliniaRetryableError
• type ErrorType
  • func ParseErrorType(s string) (ErrorType, error)
  • func (e ErrorType) String() string
  • func (e ErrorType) Validate() error

Constants

const (
	// The Invalid type should not be used, only useful to assert whether or not an error is an MdmError during cast
	ErrorTypeUnspecified        = ErrorType("")
	ErrorTypeAlreadyExists      = ErrorType("ALREADY_EXISTS")
	ErrorTypeFailedPrecondition = ErrorType("FAILED_PRECONDITION")
	ErrorTypeInternal           = ErrorType("INTERNAL")
	ErrorTypeInvalidArgument    = ErrorType("INVALID_ARGUMENT")
	ErrorTypeNotFound           = ErrorType("NOT_FOUND")
	ErrorTypeOutOfRange         = ErrorType("OUT_OF_RANGE")
	ErrorTypeUnimplemented      = ErrorType("UNIMPLEMENTED")
	ErrorTypeUnauthenticated    = ErrorType("UNAUTHENTICATED")
	ErrorTypePermissionDenied   = ErrorType("PERMISSION_DENIED")
)

Functions

func IsAlreadyExistsError

func IsAlreadyExistsError(e error) bool

func IsFailedPreconditionError

func IsFailedPreconditionError(e error) bool

func IsInternalError

func IsInternalError(e error) bool

func IsInvalidArgumentError

func IsInvalidArgumentError(e error) bool

func IsNotFoundError

func IsNotFoundError(e error) bool

func IsOutOfRange

func IsOutOfRange(e error) bool

func IsPermissionDeniedError

func IsPermissionDeniedError(e error) bool

func IsUnauthenticatedError

func IsUnauthenticatedError(e error) bool

func IsUnimplemented

func IsUnimplemented(e error) bool

func PanicsWithCliniaError

func PanicsWithCliniaError(t *testing.T, expected CliniaError, f func())

PanicsWithCliniaError asserts that the provided function panics with the expected CliniaError. This is functionally equivalent to require.PanicsWithValue, but with a CliniaError (since our error type contains slices which are not comparable with the `==` operator).

Types

type CliniaError

type CliniaError struct {
	Type    ErrorType `json:"type"`
	Message string    `json:"message"`

	// Not returned to clients
	OriginalError error
	// List of errors that caused the error if applicable
	Details []CliniaError
}

func AlreadyExistsErrorf

func AlreadyExistsErrorf(format string, args ...interface{}) CliniaError

AlreadyExistsErrorf creates a CliniaError with type ErrorTypeAlreadyExists and a formatted message

func FailedPreconditionErrorf

func FailedPreconditionErrorf(format string, args ...interface{}) CliniaError

FailedPreconditionErrorf creates a CliniaError with type ErrorTypeFailedPrecondition and a formatted message

func InternalErrorf

func InternalErrorf(format string, args ...interface{}) CliniaError

InternalErrorf creates a CliniaError with type ErrorTypeInternal and a formatted message

func InvalidArgumentErrorf

func InvalidArgumentErrorf(format string, args ...interface{}) CliniaError

InvalidArgumentErrorf creates a CliniaError with type ErrorTypeInvalidArgument and a formatted message

func IsCliniaError

func IsCliniaError(e error) (*CliniaError, bool)

func NewAlreadyExistsError

func NewAlreadyExistsError(message string) CliniaError

Deprecated: use AlreadyExistsErrorf instead

func NewCliniaErrorFromMessage

func NewCliniaErrorFromMessage(msg string) (*CliniaError, error)

func NewEnumOutOfRangeError

func NewEnumOutOfRangeError(actual string, expectedOneOf []string, enumName string) CliniaError

func NewFailedPreconditionError

func NewFailedPreconditionError(message string) CliniaError

Deprecated: use FailedPreconditionErrorf instead

func NewMultipleOutOfRangeError

func NewMultipleOutOfRangeError(actual []string, expectedOneOf []string) CliniaError

func NewNotFoundError

func NewNotFoundError(msg string, err error) CliniaError

Deprecated: use NotFoundErrorf instead

func NewSingleOutOfRangeError

func NewSingleOutOfRangeError(actual string, expectedOneOf []string) CliniaError

func NotFoundErrorf

func NotFoundErrorf(format string, args ...interface{}) CliniaError

NotFoundErrorf creates a CliniaError with type ErrorTypeNotFound and a formatted message

func OutOfRangeErrorf

func OutOfRangeErrorf(format string, args ...interface{}) CliniaError

OutOfRangeErrorf creates a CliniaError with type ErrorTypeOutOfRange and a formatted message

func PermissionDeniedErrorf

func PermissionDeniedErrorf(format string, args ...interface{}) CliniaError

PermissionDeniedErrorf creates a CliniaError with type ErrorTypePermissionDenied and a formatted message

func UnauthenticatedErrorf

func UnauthenticatedErrorf(format string, args ...interface{}) CliniaError

UnauthenticatedErrorf creates a CliniaError with type ErrorTypeUnauthenticated and a formatted message

func UnimplementedErrorf

func UnimplementedErrorf(format string, args ...interface{}) CliniaError

UnimplementedErrorf creates a CliniaError with type ErrorTypeUnimplemented and a formatted message

func (CliniaError) Error

func (e CliniaError) Error() string

func (*CliniaError) WithDetails

func (c *CliniaError) WithDetails(details ...CliniaError) CliniaError

WithDetails allows to attach multiple errors to the error

type CliniaRetryableError

type CliniaRetryableError = CliniaError

func NewInternalError

func NewInternalError(e error) CliniaRetryableError

Deprecated: use InternalErrorf instead

type ErrorType

type ErrorType string

func ParseErrorType

func ParseErrorType(s string) (ErrorType, error)

func (ErrorType) String

func (e ErrorType) String() string

func (ErrorType) Validate

func (e ErrorType) Validate() error