rkerror

Documentation

Overview

Package rkerror defines RK style API errors.

Index

• type ErrorAMZN
  • func (err *ErrorAMZN) Code() int
  • func (err *ErrorAMZN) Details() []interface{}
  • func (err *ErrorAMZN) Error() string
  • func (err *ErrorAMZN) Message() string
• type ErrorBuilder
  • func NewErrorBuilderAMZN() ErrorBuilder
  • func NewErrorBuilderGoogle() ErrorBuilder
• type ErrorBuilderAMZN
  • func (e *ErrorBuilderAMZN) New(code int, msg string, details ...interface{}) ErrorInterface
  • func (e *ErrorBuilderAMZN) NewCustom() ErrorInterface
• type ErrorBuilderGoogle
  • func (e *ErrorBuilderGoogle) New(code int, msg string, details ...interface{}) ErrorInterface
  • func (e *ErrorBuilderGoogle) NewCustom() ErrorInterface
• type ErrorElementAMZN
• type ErrorGoogle
  • func (err *ErrorGoogle) Code() int
  • func (err *ErrorGoogle) Details() []interface{}
  • func (err *ErrorGoogle) Error() string
  • func (err *ErrorGoogle) Message() string
• type ErrorInterface

Types

type ErrorAMZN

type ErrorAMZN struct {
	Resp struct {
		Errors []*ErrorElementAMZN `json:"errors" yaml:"errors"`
	} `json:"response" yaml:"response"`
}

func (*ErrorAMZN) Code

func (err *ErrorAMZN) Code() int

func (*ErrorAMZN) Details

func (err *ErrorAMZN) Details() []interface{}

func (*ErrorAMZN) Error

func (err *ErrorAMZN) Error() string

Error returns string of error

func (*ErrorAMZN) Message

func (err *ErrorAMZN) Message() string

type ErrorBuilder

type ErrorBuilder interface {
	New(code int, msg string, details ...interface{}) ErrorInterface

	NewCustom() ErrorInterface
}

func NewErrorBuilderAMZN

func NewErrorBuilderAMZN() ErrorBuilder

func NewErrorBuilderGoogle

func NewErrorBuilderGoogle() ErrorBuilder

type ErrorBuilderAMZN

type ErrorBuilderAMZN struct{}

func (*ErrorBuilderAMZN) New

func (e *ErrorBuilderAMZN) New(code int, msg string, details ...interface{}) ErrorInterface

func (*ErrorBuilderAMZN) NewCustom

func (e *ErrorBuilderAMZN) NewCustom() ErrorInterface

type ErrorBuilderGoogle

type ErrorBuilderGoogle struct{}

func (*ErrorBuilderGoogle) New

func (e *ErrorBuilderGoogle) New(code int, msg string, details ...interface{}) ErrorInterface

func (*ErrorBuilderGoogle) NewCustom

func (e *ErrorBuilderGoogle) NewCustom() ErrorInterface

type ErrorElementAMZN

type ErrorElementAMZN struct {
	Err struct {
		Code    int           `json:"code" yaml:"code" example:"500"`
		Status  string        `json:"status" yaml:"status" example:"Internal Server Error"`
		Message string        `json:"message" yaml:"message" example:"Internal error occurs"`
		Details []interface{} `json:"details" yaml:"details"`
	} `json:"error" json:"error"`
}

type ErrorGoogle

type ErrorGoogle struct {
	Err struct {
		Code    int           `json:"code" yaml:"code" example:"500"`
		Status  string        `json:"status" yaml:"status" example:"Internal Server Error"`
		Message string        `json:"message" yaml:"message" example:"Internal error occurs"`
		Details []interface{} `json:"details" yaml:"details"`
	} `json:"error" yaml:"error"`
}

ErrorGoogle is standard google style error Referred google style: https://cloud.google.com/apis/design/errors

func (*ErrorGoogle) Code

func (err *ErrorGoogle) Code() int

func (*ErrorGoogle) Details

func (err *ErrorGoogle) Details() []interface{}

func (*ErrorGoogle) Error

func (err *ErrorGoogle) Error() string

Error returns string of error

func (*ErrorGoogle) Message

func (err *ErrorGoogle) Message() string

type ErrorInterface

type ErrorInterface interface {
	Error() string

	Code() int

	Message() string

	Details() []interface{}
}