response

Documentation

Index

• func BadRequestError(c echo.Context, err error) error
• func ErrorCodeStrings() []string
• func InternalError(c echo.Context) error
• func ValidationFailedError(c echo.Context, err error) error
• type ErrorCode
  • func ErrorCodeString(s string) (ErrorCode, error)
  • func ErrorCodeValues() []ErrorCode
  • func (i ErrorCode) IsAErrorCode() bool
  • func (i ErrorCode) MarshalJSON() ([]byte, error)
  • func (i ErrorCode) String() string
  • func (i *ErrorCode) UnmarshalJSON(data []byte) error
  • func (ErrorCode) Values() []string
• type ErrorResponse

Functions

func BadRequestError

func BadRequestError(c echo.Context, err error) error

func ErrorCodeStrings

func ErrorCodeStrings() []string

ErrorCodeStrings returns a slice of all String values of the enum

func InternalError

func InternalError(c echo.Context) error

InternalError should not return the details of the error to the client for safety reasons.

func ValidationFailedError

func ValidationFailedError(c echo.Context, err error) error

Types

type ErrorCode

type ErrorCode int

const (
	ErrorCodeBadRequest ErrorCode = iota + 1
	ErrorCodeValidationFailed
	ErrorCodeBadParams
	ErrorCodeInternalError
)

func ErrorCodeString

func ErrorCodeString(s string) (ErrorCode, error)

ErrorCodeString retrieves an enum value from the enum constants string name. Throws an error if the param is not part of the enum.

func ErrorCodeValues

func ErrorCodeValues() []ErrorCode

ErrorCodeValues returns all values of the enum

func (ErrorCode) IsAErrorCode

func (i ErrorCode) IsAErrorCode() bool

IsAErrorCode returns "true" if the value is listed in the enum definition. "false" otherwise

func (ErrorCode) MarshalJSON

func (i ErrorCode) MarshalJSON() ([]byte, error)

MarshalJSON implements the json.Marshaler interface for ErrorCode

func (ErrorCode) String

func (i ErrorCode) String() string

func (*ErrorCode) UnmarshalJSON

func (i *ErrorCode) UnmarshalJSON(data []byte) error

UnmarshalJSON implements the json.Unmarshaler interface for ErrorCode

func (ErrorCode) Values

func (ErrorCode) Values() []string

type ErrorResponse

type ErrorResponse struct {
	Message string    `json:"message"`
	Code    ErrorCode `json:"code"`
}