errorx

Documentation

Index

• Constants
• func IsAlreadyExistsError(e error) bool
• func IsFailedPreconditionError(e error) bool
• func IsInternalError(e error) bool
• func IsInvalidFormatError(e error) bool
• func IsNotFoundError(e error) bool
• func IsUnsupportedError(e error) bool
• type CliniaError
  • func AlreadyExistsErrorf(format string, args ...interface{}) CliniaError
  • func FailedPreconditionErrorf(format string, args ...interface{}) CliniaError
  • func InternalErrorf(format string, args ...interface{}) CliniaError
  • func InvalidFormatErrorf(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 NewInvalidFormatError(message string) CliniaError
  • func NewMultipleOutOfRangeError(actual []string, expectedOneOf []string) CliniaError
  • func NewNotFoundError(msg string, err error) CliniaError
  • func NewNotImplementedError(message string) CliniaError
  • func NewSingleOutOfRangeError(actual string, expectedOneOf []string) CliniaError
  • func NewUnsupportedError(message string) CliniaError
  • func NewUnsupportedTypeError[T1 any, T2 any](actual T1, expected T2) CliniaError
  • func NewUnsupportedValueError(actual string, expected string) CliniaError
  • func NotFoundErrorf(format string, args ...interface{}) CliniaError
  • func UnsupportedErrorf(format string, args ...interface{}) CliniaError
  • func (e CliniaError) Error() string
• 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("")
	ErrorTypeInternal      = ErrorType("INTERNAL")
	ErrorTypeOutOfRange    = ErrorType("OUT_OF_RANGE")
	ErrorTypeUnsupported   = ErrorType("UNSUPPORTED") // Bad request
	ErrorTypeNotFound      = ErrorType("NOT_FOUND")
	ErrorTypeAlreadyExists = ErrorType("ALREADY_EXISTS") // Conflict
	// Map to 422
	ErrorTypeInvalidFormat = ErrorType("INVALID_FORMAT")
	// Map to 400
	ErrorTypeFailedPrecondition = ErrorType("FAILED_PRECONDITION")
	ErrorTypeNotImplemented     = ErrorType("NOT_IMPLEMENTED")
)

Functions

func IsAlreadyExistsError

func IsAlreadyExistsError(e error) bool

func IsFailedPreconditionError

func IsFailedPreconditionError(e error) bool

func IsInternalError

func IsInternalError(e error) bool

func IsInvalidFormatError

func IsInvalidFormatError(e error) bool

func IsNotFoundError

func IsNotFoundError(e error) bool

func IsUnsupportedError

func IsUnsupportedError(e error) bool

Types

type CliniaError

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

	OriginalError error // Not returned to clients
}

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 InvalidFormatErrorf

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

InvalidFormatErrorf creates a CliniaError with type ErrorTypeInvalidFormat 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 NewInvalidFormatError

func NewInvalidFormatError(message string) CliniaError

Deprecated: use UnsupportedErrorf instead

func NewMultipleOutOfRangeError

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

func NewNotFoundError

func NewNotFoundError(msg string, err error) CliniaError

Deprecated: use NotFoundErrorf instead

func NewNotImplementedError

func NewNotImplementedError(message string) CliniaError

Deprecated: use InternalErrorf instead

func NewSingleOutOfRangeError

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

func NewUnsupportedError

func NewUnsupportedError(message string) CliniaError

Deprecated: use UnsupportedErrorf instead

func NewUnsupportedTypeError

func NewUnsupportedTypeError[T1 any, T2 any](actual T1, expected T2) CliniaError

func NewUnsupportedValueError

func NewUnsupportedValueError(actual string, expected string) CliniaError

func NotFoundErrorf

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

NotFoundErrorf creates a CliniaError with type ErrorTypeNotFound and a formatted message

func UnsupportedErrorf

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

UnsupportedErrorf creates a CliniaError with type ErrorTypeUnsupported and a formatted message

func (CliniaError) Error

func (e CliniaError) Error() string

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