common

Documentation

Overview

Common tools and helper functions

Index

• Constants
• Variables
• func Bind(c *gin.Context, obj interface{}) error
• func BintoUint32(b []byte) uint32
• func GenToken(id uint32) string
• func GetDB() *slowpoke.Db
• func GetMasterSlave(master uint32, slave uint32) ([]byte, []byte)
• func Init() *slowpoke.Db
• func RandString(n int) string
• func ResetUsersDBWithMock()
• func TestDBFree() error
• func TestDBInit() *slowpoke.Db
• func Uint32toBin(id uint32) []byte
• type CommonError
  • func NewError(key string, err error) CommonError
  • func NewValidatorError(err error) CommonError
• type Database

Constants

const NBRandomPassword = "A String Very Very Very Niubilty!!@##$!@#4"

const NBSecretPassword = "A String Very Very Very Strong!!@##$!@#$"

Keep this two config private, it should not expose to open source

Variables

var DB *slowpoke.Db

Functions

func Bind

func Bind(c *gin.Context, obj interface{}) error

Changed the c.MustBindWith() -> c.ShouldBindWith(). I don't want to auto return 400 when error happened. origin function is here: https://github.com/gin-gonic/gin/blob/master/context.go

func BintoUint32

func BintoUint32(b []byte) uint32

func GenToken

func GenToken(id uint32) string

A Util function to generate jwt_token which can be used in the request header

func GetDB

func GetDB() *slowpoke.Db

Using this function to get a connection, you can create your connection pool here.

func GetMasterSlave

func GetMasterSlave(master uint32, slave uint32) ([]byte, []byte)

func Init

func Init() *slowpoke.Db

Opening a database and save the reference to `Database` struct.

func RandString

func RandString(n int) string

A helper function to generate random string

func ResetUsersDBWithMock

func ResetUsersDBWithMock()

Reset test DB and create new one with mock data

func TestDBFree

func TestDBFree() error

Delete the database after running testing cases.

func TestDBInit

func TestDBInit() *slowpoke.Db

This function will create a temporarily database for running testing cases

func Uint32toBin

func Uint32toBin(id uint32) []byte

Types

type CommonError

type CommonError struct {
	Errors map[string]interface{} `json:"errors"`
}

My own Error type that will help return my customized Error info

{"database": {"hello":"no such table", error: "not_exists"}}

func NewError

func NewError(key string, err error) CommonError

Warp the error info in a object

func NewValidatorError

func NewValidatorError(err error) CommonError

To handle the error returned by c.Bind in gin framework https://github.com/go-playground/validator/blob/v9/_examples/translations/main.go

type Database

type Database struct {
	*slowpoke.Db
}