engine

Documentation

Index

• Constants
• func ClearSession(c *gin.Context) (err error)
• func GetSession(c *gin.Context) (session sessions.Session, err error)
• func ReqGetPager(gc *gin.Context, pageSize int) (pager *utilHttp.Paginator)
• func SaveSession(c *gin.Context) (err error)
• type GinEngine
  • func NewGinEngine() (e *GinEngine)
  • func (e *GinEngine) Debug(debug bool) *GinEngine
  • func (e *GinEngine) UseDefault() *GinEngine
  • func (e *GinEngine) UseMultiTemplate(templates []*GinTemplate, templateBasePath string) (err error)
  • func (e *GinEngine) UseSessions(store sessions.Store, name string, options sessions.Options, regStructs ...any) *GinEngine
• type GinTemplate
• type Response
  • func GetResponse(gc *gin.Context) (response *Response)
  • func (res *Response) Failed(msg string, code ...int) *Response
  • func (res *Response) RenderApiJson(gc *gin.Context)
  • func (res *Response) RenderHtml(templateName string, gc *gin.Context)
  • func (res *Response) RenderJson(gc *gin.Context)
  • func (res *Response) SetData(v interface{}) *Response
  • func (res *Response) Success(msg string, code ...int) *Response
  • func (res *Response) WithDebug(v string) *Response
  • func (res *Response) WithError(v string) *Response
  • func (res *Response) WithVariables(v interface{}, k string) *Response

Constants

const (
	ContextVariablesKeyPager = "_gin_extend_context_variables_key_pager"
)

const (
	ContextVariablesKeyResponse = "_gin_extend_context_variables_key_response"
)

Functions

func ClearSession

func ClearSession(c *gin.Context) (err error)

func GetSession

func GetSession(c *gin.Context) (session sessions.Session, err error)

func ReqGetPager

func ReqGetPager(gc *gin.Context, pageSize int) (pager *utilHttp.Paginator)

func SaveSession

func SaveSession(c *gin.Context) (err error)

Types

type GinEngine

type GinEngine struct {
	*gin.Engine
}

func NewGinEngine

func NewGinEngine() (e *GinEngine)

func (*GinEngine) Debug

func (e *GinEngine) Debug(debug bool) *GinEngine

func (*GinEngine) UseDefault

func (e *GinEngine) UseDefault() *GinEngine

func (*GinEngine) UseMultiTemplate

func (e *GinEngine) UseMultiTemplate(templates []*GinTemplate, templateBasePath string) (err error)

func (*GinEngine) UseSessions

func (e *GinEngine) UseSessions(store sessions.Store, name string, options sessions.Options, regStructs ...any) *GinEngine

type GinTemplate

type GinTemplate = struct {
	Files  string `json:"files"`
	Layout string `json:"layout"`
}

type Response

type Response struct {
	Status     bool
	StatusCode int
	Message    string

	Debugs    []string
	Errors    []string
	Variables map[string]interface{}
	Data      interface{}
	// contains filtered or unexported fields
}

func GetResponse

func GetResponse(gc *gin.Context) (response *Response)

func (*Response) Failed

func (res *Response) Failed(msg string, code ...int) *Response

func (*Response) RenderApiJson

func (res *Response) RenderApiJson(gc *gin.Context)

func (*Response) RenderHtml

func (res *Response) RenderHtml(templateName string, gc *gin.Context)

func (*Response) RenderJson

func (res *Response) RenderJson(gc *gin.Context)

func (*Response) SetData

func (res *Response) SetData(v interface{}) *Response

func (*Response) Success

func (res *Response) Success(msg string, code ...int) *Response

func (*Response) WithDebug

func (res *Response) WithDebug(v string) *Response

func (*Response) WithError

func (res *Response) WithError(v string) *Response

func (*Response) WithVariables

func (res *Response) WithVariables(v interface{}, k string) *Response