rescode

Documentation

Index

• Variables
• type R
• type RC
  • func (r *RC) Error() string
  • func (r *RC) JSON(msgs ...string) map[string]interface{}
  • func (r *RC) OriginalError() error
  • func (r *RC) SetData(data any) *RC
• type RcCreator
  • func New(code uint64, status int, message string, data ...any) RcCreator

Variables

var (
	ValidationFailed = New(1000, http.StatusUnprocessableEntity, "validation_failed")
	Failed           = New(1001, http.StatusInternalServerError, "failed")
	NotFound         = New(1002, http.StatusNotFound, "not_found")
)

Types

type R

type R map[string]interface{}

any is a type alias for interface{}. It is used to store any type of data.

type RC

type RC struct {

	// Code is the code of the error.
	Code uint64

	// Message is the message of the error.
	Message string

	// StatusCode is the http/rpc status code of the error.
	StatusCode int

	// Data is the data of the error.
	Data any
	// contains filtered or unexported fields
}

RC is a struct that contains the code, message, http status, and translateable. Code is the code of the error.

func (*RC) Error

func (r *RC) Error() string

func (*RC) JSON

func (r *RC) JSON(msgs ...string) map[string]interface{}

JSON is a function to return the RC as a JSON.

func (*RC) OriginalError

func (r *RC) OriginalError() error

func (*RC) SetData

func (r *RC) SetData(data any) *RC

type RcCreator

type RcCreator func(err error) *RC

func New

func New(code uint64, status int, message string, data ...any) RcCreator

New is a function to create a new RC.