mux

package module
v1.6.0 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Oct 29, 2025 License: GPL-2.0 Imports: 10 Imported by: 18

README

A multiplexer for Go

Supports
  • Variables in the path
  • The stdlib http.Handler interface (Also webassembly!)
  • stdlib http.ResponseWriter/http.Request functions
  • Route namespaces

For examples; please do not hesitate to look at the router_tests.go file.

Documentation

Index

Constants

View Source 
const (
	ErrRouteNotFound      = Error("route not found")
	ErrTooManyVariables   = Error("too many variables provided to replace in path")
	ErrNotEnoughVariables = Error("not enough variables provided to replace in path")
)
View Source 
const (
	// A special method, which will not be returned by any request, but can be set on the route to allow any method to pass.
	ANY     = "*"
	GET     = "GET"     // Equivalent to http.MethodGet
	POST    = "POST"    // Equivalent to http.MethodPost
	PUT     = "PUT"     // Equivalent to http.MethodPut
	DELETE  = "DELETE"  // Equivalent to http.MethodDelete
	HEAD    = "HEAD"    // Equivalent to http.MethodHead
	PATCH   = "PATCH"   // Equivalent to http.MethodPatch
	OPTIONS = "OPTIONS" // Equivalent to http.MethodOptions

	NAME_SEPARATOR = ":"
)

Variables

View Source 
var (
	VARIABLE_DELIMS = []string{"<<", ">>"}
	URL_DELIM       = "/"
	GLOB            = "*"
)

Global variables for use in the package.

These are exported so that they can be changed if needed.

Functions

func ContextWithRoute added in v1.4.3 

func ContextWithRoute(ctx context.Context, route *Route) context.Context

func GetHost 

func GetHost(r *http.Request) string

func GetIP 

func GetIP(r *http.Request, proxied bool) string

func SetContextVars added in v1.5.7 

func SetContextVars(r *http.Request, v Variables) *http.Request

func SplitPath 

func SplitPath(path string) []string

SplitPath splits a path into its parts.

Types

type BindableHandler added in v1.5.7 

type BindableHandler interface {
	Handler
	Bind(r *http.Request, rt *Route, vars Variables) Handler
}

type ContextKey added in v1.5.7 

type ContextKey struct {
	K string
}

Exported ContextKey struct allows third party packages to work with the context more freely.

type Error added in v1.3.0 

type Error string

func (Error) Error added in v1.3.0 

func (e Error) Error() string

type FuncHandler added in v1.5.7 

type FuncHandler struct {
	Func HandleFunc
}

func (*FuncHandler) ServeHTTP added in v1.5.7 

func (h *FuncHandler) ServeHTTP(w http.ResponseWriter, req *http.Request)

type HandleFunc 

type HandleFunc func(w http.ResponseWriter, req *http.Request)

type Handler 

type Handler = http.Handler

func NewHandler 

func NewHandler(f HandleFunc) Handler

type Middleware 

type Middleware = func(next Handler) Handler

Middleware which will run before/after the HandleFunc.

type Multiplexer added in v1.4.3 

type Multiplexer interface {
	Use(middleware ...Middleware)
	Handle(method string, path string, handler Handler, name ...string) *Route
	HandleFunc(method string, path string, handler func(w http.ResponseWriter, r *http.Request), name ...string) *Route
	AddRoute(route *Route)

	Any(path string, handler Handler, name ...string) *Route
	Get(path string, handler Handler, name ...string) *Route
	Post(path string, handler Handler, name ...string) *Route
	Put(path string, handler Handler, name ...string) *Route
	Patch(path string, handler Handler, name ...string) *Route
	Delete(path string, handler Handler, name ...string) *Route
}

The interface for our multiplexer

This is a wrapper around the nigel2392/mux.Mux interface

type Mux 

type Mux struct {
	NotFoundHandler http.HandlerFunc
	// contains filtered or unexported fields
}

The muxer.

func New 

func New() *Mux

func (*Mux) AddRoute added in v1.2.5 

func (r *Mux) AddRoute(rt *Route)

func (*Mux) Any 

func (r *Mux) Any(path string, handler Handler, name ...string) *Route

func (*Mux) Delete 

func (r *Mux) Delete(path string, handler Handler, name ...string) *Route

func (*Mux) Find 

func (r *Mux) Find(name string) *Route

func (*Mux) Get 

func (r *Mux) Get(path string, handler Handler, name ...string) *Route

func (*Mux) Handle 

func (r *Mux) Handle(method string, path string, handler Handler, name ...string) *Route

func (*Mux) HandleFunc added in v1.2.0 

func (r *Mux) HandleFunc(method string, path string, handler func(w http.ResponseWriter, r *http.Request), name ...string) *Route

func (*Mux) Head 

func (r *Mux) Head(path string, handler Handler, name ...string) *Route

func (*Mux) Match 

func (r *Mux) Match(method string, path string) (*Route, Variables)

func (*Mux) Namespace added in v1.4.3 

func (r *Mux) Namespace(opts NamespaceOptions) Multiplexer

Namespace allows you to create a new Multiplexer with speficic functions to run on the added routes.

func (*Mux) NotFound 

func (r *Mux) NotFound(w http.ResponseWriter, req *http.Request)

func (*Mux) Options 

func (r *Mux) Options(path string, handler Handler, name ...string) *Route

func (*Mux) Patch 

func (r *Mux) Patch(path string, handler Handler, name ...string) *Route

func (*Mux) Post 

func (r *Mux) Post(path string, handler Handler, name ...string) *Route

func (*Mux) Put 

func (r *Mux) Put(path string, handler Handler, name ...string) *Route

func (*Mux) RemoveByPath added in v1.0.4 

func (r *Mux) RemoveByPath(path string)

func (*Mux) RemoveRoute added in v1.0.4 

func (r *Mux) RemoveRoute(route *Route)

func (*Mux) ResetRoutes added in v1.0.5 

func (r *Mux) ResetRoutes()

func (*Mux) Resolve added in v1.6.0 

func (r *Mux) Resolve(method, path string) (http.Handler, Variables, bool)

Mirrors ServeHTTP but returns the handler, variables, and whether a match was found.

ServeHTTP is more efficient if you just want to serve the request directly, skipping an extra allocation for the returned function (handler).

func (*Mux) Reverse added in v1.3.0 

func (r *Mux) Reverse(name string, variables ...interface{}) (string, error)

func (*Mux) ServeHTTP 

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

func (*Mux) Use 

func (r *Mux) Use(middleware ...Middleware)

type NamespaceOptions added in v1.4.3 

type NamespaceOptions struct {
	OnRouteAdded func(route *Route)
	OnRouteServe func(r *http.Request) *http.Request
}

type PathInfo 

type PathInfo struct {
	IsGlob   bool
	Parent   *PathInfo
	Path     []*PathPart
	Resolver Resolver
}

PathInfo contains information about a path.

It can be used to match a path, and retrieve variables from it.

func NewPathInfo 

func NewPathInfo(rt *Route, path string) *PathInfo

NewPathInfo creates a new PathInfo object from a path string.

The path string can contain variables, which are defined by the text between the VARIABLE_DELIMS.

This function will panic if the GLOB is not the last part of the path.

func (*PathInfo) Match 

func (p *PathInfo) Match(path []string, from int, variables Variables) (matched bool, nextFrom int, vars Variables)

Match matches a path to this path.

It returns whether the path matched, and the variables in the path.

If the path does not match, the variables will be nil.

func (*PathInfo) Reverse added in v1.3.0 

func (p *PathInfo) Reverse(variables ...interface{}) (string, error)

Reverse returns the path with the variables replaced.

If a variable is not found, this function will error.

func (*PathInfo) String 

func (p *PathInfo) String() string

String returns a string representation of the path.

func (*PathInfo) WithParent added in v1.4.8 

func (p *PathInfo) WithParent(parent *PathInfo) *PathInfo

WithParent returns a new PathInfo with the given parent.

type PathPart 

type PathPart struct {
	Part       string
	IsVariable bool
	IsGlob     bool
}

PathPart contains information about a part of a path.

type Resolver added in v1.4.0 

type Resolver interface {
	Reverse(baseURL string, variables ...interface{}) (string, error)
	Match(vars Variables, path []string) (bool, Variables)
}

type Route 

type Route struct {
	Name               string
	Method             string
	Middleware         []Middleware
	PreMiddleware      []Middleware
	Path               *PathInfo
	Children           []*Route
	Handler            Handler
	Parent             *Route
	ParentMux          *Mux
	DisabledMiddleware bool // Is middleware disabled for this route?
	// contains filtered or unexported fields
}

func NewRoute added in v1.2.5 

func NewRoute(method, path string, handler Handler, name ...string) *Route

func RouteFromContext added in v1.4.3 

func RouteFromContext(ctx context.Context) *Route

func (*Route) AddRoute added in v1.2.5 

func (r *Route) AddRoute(rt *Route)

func (*Route) Any 

func (r *Route) Any(path string, handler Handler, name ...string) *Route

func (*Route) Delete 

func (r *Route) Delete(path string, handler Handler, name ...string) *Route

func (*Route) Find 

func (r *Route) Find(names []string) (*Route, bool)

func (*Route) Get 

func (r *Route) Get(path string, handler Handler, name ...string) *Route

func (*Route) Handle 

func (r *Route) Handle(method string, path string, handler Handler, name ...string) *Route

Handle adds a handler to the route.

It returns the route that was added so that it can be used to add children.

func (*Route) HandleFunc 

func (r *Route) HandleFunc(method string, path string, handler func(w http.ResponseWriter, r *http.Request), name ...string) *Route

func (*Route) Head 

func (r *Route) Head(path string, handler Handler, name ...string) *Route

func (*Route) ID added in v1.0.5 

func (r *Route) ID() int64

func (*Route) Match 

func (r *Route) Match(method string, path []string) (*Route, bool, Variables)

Route.Match tries to match this route (from the beginning of the path) and, on partial match, descends into children carrying the "from" index.

func (*Route) Options 

func (r *Route) Options(path string, handler Handler, name ...string) *Route

func (*Route) Patch 

func (r *Route) Patch(path string, handler Handler, name ...string) *Route

func (*Route) PathName added in v1.5.6 

func (r *Route) PathName() []string

func (*Route) Post 

func (r *Route) Post(path string, handler Handler, name ...string) *Route

func (*Route) Preprocess added in v1.3.9 

func (r *Route) Preprocess(middleware ...Middleware)

Preprocess adds middleware to the route that will be executed before any other middleware or handler.

func (*Route) Put 

func (r *Route) Put(path string, handler Handler, name ...string) *Route

func (*Route) RemoveByPath added in v1.0.4 

func (r *Route) RemoveByPath(path string) bool

func (*Route) RemoveChild added in v1.0.4 

func (r *Route) RemoveChild(child *Route)

func (*Route) RunsMiddleware added in v1.3.5 

func (r *Route) RunsMiddleware(b bool)

DisableMiddleware disables the middleware for the route.

func (*Route) String 

func (r *Route) String() string

String returns a string representation of the route.

func (*Route) Use added in v1.2.0 

func (r *Route) Use(middleware ...Middleware)

Use adds middleware to the route.

type Variables 

type Variables map[string][]string

func Vars 

func Vars(r *http.Request) Variables

func (Variables) Get 

func (v Variables) Get(key string) string

func (Variables) GetAll 

func (v Variables) GetAll(key string) []string

func (Variables) GetInt 

func (v Variables) GetInt(key string) int

Source Files

View all Source files

Directories

Path Synopsis
authentication
sessions

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.