routing

Documentation

Index

• Constants
• Variables
• func MethodRouteVersionToPattern(method, route, version string) string
• func ParseToParamKey(str string) (string, map[string][]int)
• func PatternToMethodRouteVersion(pattern string) (string, string, string)
• func ToEndpoint(str string) string
• type Node
• type Router
  • func NewRouter() *Router
  • func (r *Router) Add(method, route, version string, handler ctx.Handler) *Router
  • func (r *Router) AddInjectableHandler(method, route, version string, handler any) *Router
  • func (r *Router) For(methodInclusions []string, route string, version string) func(handlers ...ctx.Handler) *Router
  • func (r *Router) Group(prefix string, subRouters ...*Router) *Router
  • func (r *Router) Match(method, route, version string) (bool, string, map[string][]int, []string, []ctx.Handler)
  • func (r *Router) Use(handlers ...ctx.Handler) *Router
• type RouterItem
• type ScanFn
• type Trie
  • func NewTrie() *Trie
  • func (tr *Trie) ToJSON() (string, error)

Constants

const (
	ADD = iota + 1
	USE
	FOR
	GROUP
)

const SERVE = "SERVE" // Serving static files directive

Variables

var HTTPMethods = []string{
	http.MethodGet,
	http.MethodHead,
	http.MethodPost,
	http.MethodPut,
	http.MethodPatch,
	http.MethodDelete,
	http.MethodConnect,
	http.MethodOptions,
	http.MethodTrace,
	SERVE,
}

var OperationsMapHTTPMethods = map[string]string{
	http.MethodGet:     http.MethodGet,
	http.MethodHead:    http.MethodHead,
	http.MethodPost:    http.MethodPost,
	http.MethodPut:     http.MethodPut,
	http.MethodPatch:   http.MethodPatch,
	http.MethodDelete:  http.MethodDelete,
	http.MethodConnect: http.MethodConnect,
	http.MethodOptions: http.MethodOptions,
	http.MethodTrace:   http.MethodTrace,
	SERVE:              http.MethodGet,
}

Functions

func MethodRouteVersionToPattern

func MethodRouteVersionToPattern(method, route, version string) string

func ParseToParamKey

func ParseToParamKey(str string) (string, map[string][]int)

func PatternToMethodRouteVersion

func PatternToMethodRouteVersion(pattern string) (string, string, string)

func ToEndpoint

func ToEndpoint(str string) string

Types

type Node

type Node map[string]*Trie

type Router

type Router struct {
	*Trie
	Hash               map[string]RouterItem
	List               []string
	GlobalMiddlewares  []ctx.Handler
	InjectableHandlers map[string]any
}

func NewRouter

func NewRouter() *Router

func (*Router) Add

func (r *Router) Add(method, route, version string, handler ctx.Handler) *Router

alway use latest add

func (*Router) AddInjectableHandler

func (r *Router) AddInjectableHandler(method, route, version string, handler any) *Router

func (*Router) For

func (r *Router) For(methodInclusions []string, route string, version string) func(handlers ...ctx.Handler) *Router

func (*Router) Group

func (r *Router) Group(prefix string, subRouters ...*Router) *Router

func (*Router) Match

func (r *Router) Match(method, route, version string) (bool, string, map[string][]int, []string, []ctx.Handler)

func (*Router) Use

func (r *Router) Use(handlers ...ctx.Handler) *Router

type RouterItem

type RouterItem struct {
	Index        int
	HandlerIndex int
	Handlers     []ctx.Handler
	// contains filtered or unexported fields
}

type ScanFn

type ScanFn func(string, *Trie)

type Trie

type Trie struct {
	Children  Node
	Handlers  []ctx.Handler
	ParamKeys map[string][]int
	Index     int
}

func NewTrie

func NewTrie() *Trie

func (*Trie) ToJSON

func (tr *Trie) ToJSON() (string, error)