apperror

Documentation

Overview

Package apperror defines the platform-wide application error type used to map domain and application failures to transport-level responses.

Index

• Constants
• func IsAppError(err error) bool
• type AppError
  • func Authentication(message string) *AppError
  • func Authorization(message string) *AppError
  • func Logic(message string, code Code) *AppError
  • func NotFound(message string) *AppError
  • func NotFoundEntity(entity string) *AppError
  • func Validation(validationErrors map[string]string) *AppError
  • func (e *AppError) Error() string
  • func (e *AppError) IsAuthentication() bool
  • func (e *AppError) IsAuthorization() bool
  • func (e *AppError) IsLogic() bool
  • func (e *AppError) IsNotFound() bool
  • func (e *AppError) IsValidation() bool
• type Code
• type Type

Constants

const (
	CodeValidation     = Code(TypeValidation)
	CodeNotFound       = Code(TypeNotFound)
	CodeAuthentication = Code(TypeAuthentication)
	CodeAuthorization  = Code(TypeAuthorization)
)

Functions

func IsAppError

func IsAppError(err error) bool

Types

type AppError

type AppError struct {
	Type    Type          `json:"type"`
	Code    Code          `json:"code"`
	Message string        `json:"message"`
	Details []interface{} `json:"details"`
}

func Authentication

func Authentication(message string) *AppError

func Authorization

func Authorization(message string) *AppError

func Logic

func Logic(message string, code Code) *AppError

func NotFound

func NotFound(message string) *AppError

func NotFoundEntity

func NotFoundEntity(entity string) *AppError

func Validation

func Validation(validationErrors map[string]string) *AppError

func (*AppError) Error

func (e *AppError) Error() string

func (*AppError) IsAuthentication

func (e *AppError) IsAuthentication() bool

func (*AppError) IsAuthorization

func (e *AppError) IsAuthorization() bool

func (*AppError) IsLogic

func (e *AppError) IsLogic() bool

func (*AppError) IsNotFound

func (e *AppError) IsNotFound() bool

func (*AppError) IsValidation

func (e *AppError) IsValidation() bool

type Code

type Code string

type Type

type Type string

const (
	TypeLogic          Type = "logic"
	TypeValidation     Type = "validation"
	TypeNotFound       Type = "not_found"
	TypeAuthentication Type = "authentication"
	TypeAuthorization  Type = "authorization"
)