grouter

Documentation

Index

• type GRouter
  • func New() *GRouter
  • func (g *GRouter) Bind() error
  • func (g *GRouter) GetHandlersWithCache(r *Request) bool
  • func (g *GRouter) Group(prefix string, groups ...func(group *RouterGroup)) *RouterGroup
• type HandlerFunc
• type Request
  • func (r *Request) GetRouterString(key string, def ...interface{}) string
  • func (r *Request) GetRouterValue(key string, def ...interface{}) interface{}
  • func (r *Request) GetRouterVar(key string, def ...interface{}) *gvar.Var
• type Router
• type RouterGroup
  • func (g *RouterGroup) Clone() *RouterGroup
  • func (g *RouterGroup) GET(pattern string, object HandlerFunc) *RouterGroup

Types

type GRouter

type GRouter struct {
	// contains filtered or unexported fields
}

func New

func New() *GRouter

func (*GRouter) Bind

func (g *GRouter) Bind() error

func (*GRouter) GetHandlersWithCache

func (g *GRouter) GetHandlersWithCache(r *Request) bool

func (*GRouter) Group

func (g *GRouter) Group(prefix string, groups ...func(group *RouterGroup)) *RouterGroup

type HandlerFunc

type HandlerFunc = func(r *Request)

Request handler function.

type Request

type Request struct {
	URL       string
	Payload   interface{}
	RouterMap map[string]string // Router parameters map, which might be nil if there're no router parameters.
}

func (*Request) GetRouterString

func (r *Request) GetRouterString(key string, def ...interface{}) string

GetRouterString retrieves and returns the router value as string with given key name <key>. It returns <def> if <key> does not exist.

func (*Request) GetRouterValue

func (r *Request) GetRouterValue(key string, def ...interface{}) interface{}

GetRouterValue retrieves and returns the router value with given key name <key>. It returns <def> if <key> does not exist.

func (*Request) GetRouterVar

func (r *Request) GetRouterVar(key string, def ...interface{}) *gvar.Var

GetRouterVar retrieves and returns the router value as gvar.Var with given key name <key>. It returns <def> if <key> does not exist.

type Router

type Router struct {
	Uri      string   // URI.
	RegRule  string   // Parsed regular expression for route matching.
	RegNames []string // Parsed router parameter names.
	Priority int      // Just for reference.
}

Router object.

type RouterGroup

type RouterGroup struct {
	// contains filtered or unexported fields
}

RouterGroup is a group wrapping multiple routes and middleware.

func (*RouterGroup) Clone

func (g *RouterGroup) Clone() *RouterGroup

Clone returns a new router group which is a clone of current group.

func (*RouterGroup) GET

func (g *RouterGroup) GET(pattern string, object HandlerFunc) *RouterGroup

GET registers a http handler to given route pattern and http method: GET.