utils

Documentation

Index

• Constants
• func NewError(ctx *gin.Context, status int, err error)
• func ParseClueID(clueString string, gameId int64, rm map[string]int) int64
• func ParseRoundAndColumn(clueString string) (int64, int64)
• func StringPtr(s string) *string
• func Truncate(s string, n int, pad *string) string
• type HTTPError

Constants

const TRUNCATE_MAX = 40

Functions

func NewError

func NewError(ctx *gin.Context, status int, err error)

NewError creates an error in the gin context.

TODO: log error in this helper function

func ParseClueID

func ParseClueID(clueString string, gameId int64, rm map[string]int) int64

ParseClueID converts a clue string to a clue ID. Clue strings have the format "clue_DJ_1_2", "clue_FJ" and the parsed int64 is of the form <game_id>0<round>0<clue_index>.

func ParseRoundAndColumn

func ParseRoundAndColumn(clueString string) (int64, int64)

ParseRoundAndColumn parses a clue string and returns the round and column.

func StringPtr

func StringPtr(s string) *string

StringPtr returns a pointer to a string.

func Truncate

func Truncate(s string, n int, pad *string) string

Truncate truncates a string to n characters. If pad is not nil, then the string is padded with pad until it is n characters long.

Types

type HTTPError

type HTTPError struct {
	Code    int    `json:"code" example:"400"`
	Message string `json:"message" example:"status bad request"`
}

HTTPError is the error response for the API.