codes

Documentation

Index

• Constants
• func GetCodeMessages(code Code) map[language.Language]Message
• type Code
  • func (c *Code) IsBetween(startCode Code, endCode Code) bool
  • func (c *Code) IsNotOneOf(listCodes ...Code) bool
  • func (c *Code) IsOneOf(listCodes ...Code) bool
• type CodeInterface
• type Message
  • func Compile(code Code, lang language.Language) Message

Constants

const (
	// 2xx (default)
	MsgCodeSuccessDefault = (iota + 1)

	// 4xx
	MsgCodeErrBadRequest
	MsgCodeErrUnauthorized
	MsgCodeErrInvalidToken
	MsgCodeErrRefreshTokenExpired
	MsgCodeErrAccessTokenExpired
	MsgCodeErrForbidden
	MsgCodeErrNotFound
	MsgCodeErrContextTimeout
	MsgCodeErrConflict
	MsgCodeErrTooManyRequest

	// 5xx
	MsgCodeErrInternalServerError
	MsgCodeErrNotImplemented
	MsgCodeErrServiceUnavailable
)

code of messages

const (
	// General result error codes
	CodeSuccess = Code(iota + 1)

	// Common error codes
	CodeInvalidValue
	CodeContextDeadlineExceeded
	CodeContextCanceled
	CodeInternalServerError
	CodeServerUnavailable
	CodeNotImplemented
	CodeBadRequest
	CodeNotFound
	CodeConflict
	CodeUnauthorized
	CodeTooManyRequest
	CodeMarshal
	CodeUnmarshal
	CodeCommonEnd

	// SQL error codes
	CodeSQLStart
	CodeSQL
	CodeSQLInit
	CodeSQLBuilder
	CodeSQLTxBegin
	CodeSQLTxCommit
	CodeSQLTxRollback
	CodeSQLTxExec
	CodeSQLPrepareStmt
	CodeSQLRead
	CodeSQLRowScan
	CodeSQLRecordDoesNotExist
	CodeSQLUniqueConstraint
	CodeSQLConflict
	CodeSQLNoRowsAffected
	CodeSQLEnd

	// Client error codes
	CodeClientStart
	CodeClient
	CodeClientMarshal
	CodeClientUnmarshal
	CodeClientErrorOnRequest
	CodeClientErrorOnReadBody
	CodeClientEnd

	// Auth error codes
	CodeAuthStart
	CodeAuth
	CodeAuthRefreshTokenExpired
	CodeAuthAccessTokenExpired
	CodeAuthFailure
	CodeAuthInvalidToken
	CodeForbidden
	CodeAuthEnd

	// JSON encoding/decoding error codes
	CodeJSONSchemaStart
	CodeJSONSchema
	CodeJSONSchemaInvalid
	CodeJSONSchemaNotFound
	CodeJSONStructInvalid
	CodeJSONRawInvalid
	CodeJSONValidationError
	CodeJSONMarshalError
	CodeJSONUnmarshalError
	CodeJSONSchemaEnd

	// Storage error codes
	CodeStorageStart
	CodeStorage
	CodeStorageNoFile
	CodeStorageGenerateURLFailure
	CodeStorageNoClient
	CodeStorageEnd

	// JWT error codes
	CodeJWTStart
	CodeJWT
	CodeJWTInvalidMethod
	CodeJWTParseWithClaimsError
	CodeJWTInvalidClaimsType
	CodeJWTSignedStringError
	CodeJWTEnd

	// GraphQL error codes
	CodeGQLStart
	CodeGQL
	CodeGQLInvalidValue
	CodeGQLBuilder
	CodeGQLEnd

	// Argon2 error codes
	CodeArgon2Start
	CodeArgon2
	CodeArgon2InvalidEncodedHash
	CodeArgon2EncodeHashError
	CodeArgon2DecodeHashError
	CodeArgon2IncompatibleVersion
	CodeArgon2NotMatch
	CodeArgon2End

	// Bcrypt error codes
	CodeBcryptStart
	CodeBcrypt
	CodeBcryptEnd

	// AES 256 GCM error codes
	CodeAES256GCMStart
	CodeAES256GCM
	CodeAES256GCMOpenError
	CodeAES256GCMEnd

	// SMTP error codes
	CodeSMTPStart
	CodeSMTP
	CodeSMTPBadRequest
	CodeSMTPRequestTimeout
	CodeSMTPEnd

	// Go Identiface codes (go lib based on https://github.com/Kagami/go-face.git to identify face)
	CodeIdentifaceStart
	CodeIdentiface
	CodeIdentifaceNoFaceDetected
	CodeIdentifaceFaceNotRecognized
	CodeIdentifaceMultipleFaceDetected
	CodeIdentifaceFaceNotRegistered
	CodeIdentifaceEnd

	// Go string template codes
	CodeStrTemplateStart
	CodeStrTemplateInvalidFormat
	CodeStrTemplateExecuteErr
	CodeStrTemplateEnd

	// Go Queue codes
	CodeQueueEmpty
	CodeQueueFull
)

const (
	NoCode = math.MaxUint64
)

Default code/no code

Functions

func GetCodeMessages

func GetCodeMessages(code Code) map[language.Language]Message

Get code messages in multiple language by `codes.Code` and `language.Language`. Will return empty value if language not available.

Types

type Code

type Code uint64

Alias of unsigned int64 to identify errors by {Code}

func (*Code) IsBetween

func (c *Code) IsBetween(startCode Code, endCode Code) bool

func (*Code) IsNotOneOf

func (c *Code) IsNotOneOf(listCodes ...Code) bool

func (*Code) IsOneOf

func (c *Code) IsOneOf(listCodes ...Code) bool

type CodeInterface

type CodeInterface interface {
	IsBetween(startCode, endCode Code) bool
	IsOneOf(listCodes ...Code) bool
	IsNotOneOf(listCodes ...Code) bool
}

type Message

type Message struct {
	StatusCode int
	Title      string
	Body       string
}

Struct to store error message

func Compile

func Compile(code Code, lang language.Language) Message

Compile error codes with specific language to available messages from `codes.GetCodeMessages`