ginx

Documentation

Index

• Variables
• func MetaDataHandler(meta MetaData) gin.HandlerFunc
• type Elem
  • func (e *Elem) Bool() bool
  • func (e *Elem) Float() float64
  • func (e *Elem) Int() int
  • func (e *Elem) String() string
• type MetaData
  • func Meta(e ...Elem) MetaData
  • func MetaDataFromCtx(ctx *gin.Context) MetaData
  • func (m MetaData) Get(key string) (Elem, bool)
  • func (m MetaData) Has(key string) bool
• type RouterGroup
  • func NewRouter(group *gin.RouterGroup) *RouterGroup
  • func (r *RouterGroup) Any(path string, meta MetaData, handlers ...gin.HandlerFunc) []*RouterHandler
  • func (r *RouterGroup) Attach(handlers ...gin.HandlerFunc)
  • func (r *RouterGroup) DELETE(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler
  • func (r *RouterGroup) GET(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler
  • func (r *RouterGroup) Group(path string, subMeta MetaData, handlers ...gin.HandlerFunc) *RouterGroup
  • func (r *RouterGroup) HEAD(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler
  • func (r *RouterGroup) Handle(method string, path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler
  • func (r *RouterGroup) Match(methods []string, path string, meta MetaData, handlers ...gin.HandlerFunc) []*RouterHandler
  • func (r *RouterGroup) OPTIONS(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler
  • func (r *RouterGroup) POST(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler
  • func (r *RouterGroup) PUT(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler
  • func (r *RouterGroup) Use(handlers ...gin.HandlerFunc)
  • func (r *RouterGroup) Walk(walk func(info WalkRouteInfo) error) error
• type RouterHandler
• type WalkRouteInfo

Variables

var MetaKey = "gin.metadata"

Functions

func MetaDataHandler

func MetaDataHandler(meta MetaData) gin.HandlerFunc

Types

type Elem

type Elem struct {
	Key string
	Val any
}

Elem is element of Metadata

func (*Elem) Bool

func (e *Elem) Bool() bool

func (*Elem) Float

func (e *Elem) Float() float64

func (*Elem) Int

func (e *Elem) Int() int

func (*Elem) String

func (e *Elem) String() string

type MetaData

type MetaData map[string]any

MetaData route meta info

func Meta

func Meta(e ...Elem) MetaData

func MetaDataFromCtx

func MetaDataFromCtx(ctx *gin.Context) MetaData

func (MetaData) Get

func (m MetaData) Get(key string) (Elem, bool)

func (MetaData) Has

func (m MetaData) Has(key string) bool

type RouterGroup

type RouterGroup struct {
	FullPath string
	Meta     MetaData
	// contains filtered or unexported fields
}

func NewRouter

func NewRouter(group *gin.RouterGroup) *RouterGroup

func (*RouterGroup) Any

func (r *RouterGroup) Any(path string, meta MetaData, handlers ...gin.HandlerFunc) []*RouterHandler

func (*RouterGroup) Attach

func (r *RouterGroup) Attach(handlers ...gin.HandlerFunc)

Attach handlers to the root group directly

func (*RouterGroup) DELETE

func (r *RouterGroup) DELETE(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler

func (*RouterGroup) GET

func (r *RouterGroup) GET(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler

func (*RouterGroup) Group

func (r *RouterGroup) Group(path string, subMeta MetaData, handlers ...gin.HandlerFunc) *RouterGroup

func (*RouterGroup) HEAD

func (r *RouterGroup) HEAD(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler

func (*RouterGroup) Handle

func (r *RouterGroup) Handle(method string, path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler

func (*RouterGroup) Match

func (r *RouterGroup) Match(methods []string, path string, meta MetaData, handlers ...gin.HandlerFunc) []*RouterHandler

func (*RouterGroup) OPTIONS

func (r *RouterGroup) OPTIONS(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler

func (*RouterGroup) POST

func (r *RouterGroup) POST(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler

func (*RouterGroup) PUT

func (r *RouterGroup) PUT(path string, meta MetaData, handlers ...gin.HandlerFunc) *RouterHandler

func (*RouterGroup) Use

func (r *RouterGroup) Use(handlers ...gin.HandlerFunc)

Use append the handlers to chain, group's chain will be inherited by subgroup and sub handlers

func (*RouterGroup) Walk

func (r *RouterGroup) Walk(walk func(info WalkRouteInfo) error) error

Walk group and handlers info, include subgroup

type RouterHandler

type RouterHandler struct {
	Method   string
	FullPath string
	Meta     MetaData
	// contains filtered or unexported fields
}

type WalkRouteInfo

type WalkRouteInfo struct {
	IsGroup bool
	Group   *WalkRouteInfo

	Method   string
	FullPath string
	Meta     MetaData
}