route

Documentation

Index

• func FileServe(dir string) http.HandlerFunc
• func Param(ctx context.Context, p string) string
• func WithParam(ctx context.Context, p, v string) context.Context
• type Router
  • func New() *Router
  • func (r *Router) Del(path string, h http.HandlerFunc)
  • func (r *Router) Get(path string, h http.HandlerFunc)
  • func (r *Router) Head(path string, h http.HandlerFunc)
  • func (r *Router) Options(path string, h http.HandlerFunc)
  • func (r *Router) Post(path string, h http.HandlerFunc)
  • func (r *Router) Put(path string, h http.HandlerFunc)
  • func (r *Router) Redirect(w http.ResponseWriter, req *http.Request, path string, code int)
  • func (r *Router) ServeHTTP(w http.ResponseWriter, req *http.Request)
  • func (r *Router) WithInstrumentation(instrh func(handlerName string, handler http.HandlerFunc) http.HandlerFunc) *Router
  • func (r *Router) WithPrefix(prefix string) *Router

Functions

func FileServe

func FileServe(dir string) http.HandlerFunc

FileServe returns a new http.HandlerFunc that serves files from dir. Using routes must provide the *filepath parameter.

func Param

func Param(ctx context.Context, p string) string

Param returns param p for the context, or the empty string when param does not exist in context.

func WithParam

func WithParam(ctx context.Context, p, v string) context.Context

WithParam returns a new context with param p set to v.

Types

type Router

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

Router wraps httprouter.Router and adds support for prefixed sub-routers, per-request context injections and instrumentation.

func New

func New() *Router

New returns a new Router.

func (*Router) Del

func (r *Router) Del(path string, h http.HandlerFunc)

Del registers a new DELETE route.

func (*Router) Get

func (r *Router) Get(path string, h http.HandlerFunc)

Get registers a new GET route.

func (*Router) Head

func (r *Router) Head(path string, h http.HandlerFunc)

Head registers a new HEAD route.

func (*Router) Options

func (r *Router) Options(path string, h http.HandlerFunc)

Options registers a new OPTIONS route.

func (*Router) Post

func (r *Router) Post(path string, h http.HandlerFunc)

Post registers a new POST route.

func (*Router) Put

func (r *Router) Put(path string, h http.HandlerFunc)

Put registers a new PUT route.

func (*Router) Redirect

func (r *Router) Redirect(w http.ResponseWriter, req *http.Request, path string, code int)

Redirect takes an absolute path and sends an internal HTTP redirect for it, prefixed by the router's path prefix. Note that this method does not include functionality for handling relative paths or full URL redirects.

func (*Router) ServeHTTP

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

ServeHTTP implements http.Handler.

func (*Router) WithInstrumentation

func (r *Router) WithInstrumentation(instrh func(handlerName string, handler http.HandlerFunc) http.HandlerFunc) *Router

WithInstrumentation returns a router with instrumentation support.

func (*Router) WithPrefix

func (r *Router) WithPrefix(prefix string) *Router

WithPrefix returns a router that prefixes all registered routes with prefix.