mux

package module

Go to main page

Versions in this module

v1

v1.10.1

Aug 11, 2026

v1.10.0

May 25, 2026

v1.9.2

Dec 30, 2024

Changes in this version

+ var ErrMetadataKeyNotFound = errors.New("key not found in metadata")

+ var RegexpCompileFunc = regexp.Compile

type Route

+ func (r *Route) GetHandlerWithMiddlewares() http.Handler

+ func (r *Route) GetMetadata() map[any]any

+ func (r *Route) GetMetadataValue(key any) (any, error)

+ func (r *Route) GetMetadataValueOr(key any, fallbackValue any) any

+ func (r *Route) GetVarNames() ([]string, error)

+ func (r *Route) Metadata(key any, value any) *Route

+ func (r *Route) MetadataContains(key any) bool

+ func (r *Route) Use(mwf ...MiddlewareFunc) *Route

type Router

+ func CurrentRouter(r *http.Request) *Router

+ func (r *Router) OmitRouterFromContext(value bool) *Router

v1.9.0

Jan 23, 2023

Changes in this version

+ var ErrSkipRouter = errors.New("skip this router")

v1.8.2

Jan 22, 2023

Changes in this version

type Router

+ func (r *Router) Name(name string) *Route

+ func (r *Router) OmitRouteFromContext(value bool) *Router

v1.6.2

May 13, 2018

Changes in this version

type MiddlewareFunc

+ func CORSMethodMiddleware(r *Router) MiddlewareFunc

v1.6.1

Jan 16, 2018

Changes in this version

+ func SetURLVars(r *http.Request, val map[string]string) *http.Request

+ type MiddlewareFunc func(http.Handler) http.Handler

+ func (mw MiddlewareFunc) Middleware(handler http.Handler) http.Handler

type Router

+ func (r *Router) Use(mwf MiddlewareFunc)

v1.6.0

Nov 5, 2017

Changes in this version

+ var ErrNotFound = errors.New("no matching route was found")

type Route

+ func (r *Route) GetQueriesRegexp() ([]string, error)

+ func (r *Route) GetQueriesTemplates() ([]string, error)

v1.5.0

Sep 5, 2017

Changes in this version

+ var ErrMethodMismatch = errors.New("method is not allowed")

type RouteMatch

+ MatchErr error

type Router

+ MethodNotAllowedHandler http.Handler

v1.4.0

May 21, 2017

Changes in this version

type Route

+ func (r *Route) GetMethods() ([]string, error)

+ func (r *Route) GetPathRegexp() (string, error)

v1.3.0

Jan 18, 2017

v1.2.0

Jan 17, 2017

Changes in this version

+ var SkipRouter = errors.New("skip this router")

+ func Vars(r *http.Request) map[string]string

+ type BuildVarsFunc func(map[string]string) map[string]string

+ type MatcherFunc func(*http.Request, *RouteMatch) bool

+ func (m MatcherFunc) Match(r *http.Request, match *RouteMatch) bool

+ type Route struct

+ func CurrentRoute(r *http.Request) *Route

+ func (r *Route) BuildOnly() *Route

+ func (r *Route) BuildVarsFunc(f BuildVarsFunc) *Route

+ func (r *Route) GetError() error

+ func (r *Route) GetHandler() http.Handler

+ func (r *Route) GetHostTemplate() (string, error)

+ func (r *Route) GetName() string

+ func (r *Route) GetPathTemplate() (string, error)

+ func (r *Route) Handler(handler http.Handler) *Route

+ func (r *Route) HandlerFunc(f func(http.ResponseWriter, *http.Request)) *Route

+ func (r *Route) Headers(pairs ...string) *Route

+ func (r *Route) HeadersRegexp(pairs ...string) *Route

+ func (r *Route) Host(tpl string) *Route

+ func (r *Route) Match(req *http.Request, match *RouteMatch) bool

+ func (r *Route) MatcherFunc(f MatcherFunc) *Route

+ func (r *Route) Methods(methods ...string) *Route

+ func (r *Route) Name(name string) *Route

+ func (r *Route) Path(tpl string) *Route

+ func (r *Route) PathPrefix(tpl string) *Route

+ func (r *Route) Queries(pairs ...string) *Route

+ func (r *Route) Schemes(schemes ...string) *Route

+ func (r *Route) SkipClean() bool

+ func (r *Route) Subrouter() *Router

+ func (r *Route) URL(pairs ...string) (*url.URL, error)

+ func (r *Route) URLHost(pairs ...string) (*url.URL, error)

+ func (r *Route) URLPath(pairs ...string) (*url.URL, error)

+ type RouteMatch struct

+ Handler http.Handler

+ Route *Route

+ Vars map[string]string

+ type Router struct

+ KeepContext bool

+ NotFoundHandler http.Handler

+ func NewRouter() *Router

+ func (r *Router) BuildVarsFunc(f BuildVarsFunc) *Route

+ func (r *Router) Get(name string) *Route

+ func (r *Router) GetRoute(name string) *Route

+ func (r *Router) Handle(path string, handler http.Handler) *Route

+ func (r *Router) HandleFunc(path string, f func(http.ResponseWriter, *http.Request)) *Route

+ func (r *Router) Headers(pairs ...string) *Route

+ func (r *Router) Host(tpl string) *Route

+ func (r *Router) Match(req *http.Request, match *RouteMatch) bool

+ func (r *Router) MatcherFunc(f MatcherFunc) *Route

+ func (r *Router) Methods(methods ...string) *Route

+ func (r *Router) NewRoute() *Route

+ func (r *Router) Path(tpl string) *Route

+ func (r *Router) PathPrefix(tpl string) *Route

+ func (r *Router) Queries(pairs ...string) *Route

+ func (r *Router) Schemes(schemes ...string) *Route

+ func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (r *Router) SkipClean(value bool) *Router

+ func (r *Router) StrictSlash(value bool) *Router

+ func (r *Router) UseEncodedPath() *Router

+ func (r *Router) Walk(walkFn WalkFunc) error

+ type WalkFunc func(route *Route, router *Router, ancestors []*Route) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL