Why Go
- Case Studies
  
  Common problems companies solve with Go
- Use Cases
  
  Stories about how and why companies use Go
- Security
  
  How Go can help keep you secure by default
Learn
Docs
- Effective Go
  
  Tips for writing clear, performant, and idiomatic Go code
- Go User Manual
  
  A complete introduction to building software with Go
- Standard library
  
  Reference documentation for Go's standard library
- Release Notes
  
  Learn what's new in each Go release
Packages
Community
- Recorded Talks
  
  Videos from prior events
- Meetups
  
  Meet other local Go developers
- Conferences
  
  Learn and network with Go developers from around the world
- Go blog
  
  The Go project's official blog.
- Go project
  
  Get help and stay informed from Go
- Get connected

fox

package module

Go to main page

Versions in this module

v0

v0.27.1

Feb 5, 2026

v0.27.0

Feb 1, 2026

v0.26.3

Feb 1, 2026

Changes in this version

+ const HeaderAccept

+ const HeaderAcceptEncoding

+ const HeaderAccessControlAllowCredentials

+ const HeaderAccessControlAllowHeaders

+ const HeaderAccessControlAllowMethods

+ const HeaderAccessControlAllowOrigin

+ const HeaderAccessControlExposeHeaders

+ const HeaderAccessControlMaxAge

+ const HeaderAccessControlRequestHeaders

+ const HeaderAccessControlRequestMethod

+ const HeaderAllow

+ const HeaderAuthorization

+ const HeaderCFConnectionIP

+ const HeaderCacheControl

+ const HeaderConnection

+ const HeaderContentDisposition

+ const HeaderContentEncoding

+ const HeaderContentLength

+ const HeaderContentSecurityPolicy

+ const HeaderContentSecurityPolicyReportOnly

+ const HeaderContentType

+ const HeaderCookie

+ const HeaderETag

+ const HeaderFastClientIP

+ const HeaderFlyClientIP

+ const HeaderForwarded

+ const HeaderHost

+ const HeaderIfModifiedSince

+ const HeaderLastModified

+ const HeaderLocation

+ const HeaderOrigin

+ const HeaderProxyAuthorization

+ const HeaderReferrerPolicy

+ const HeaderRetryAfter

+ const HeaderServer

+ const HeaderSetCookie

+ const HeaderStrictTransportSecurity

+ const HeaderTrueClientIP

+ const HeaderUpgrade

+ const HeaderVary

+ const HeaderWWWAuthenticate

+ const HeaderXAppengineRemoteAddr

+ const HeaderXAzureClientIP

+ const HeaderXAzureSocketIP

+ const HeaderXCSRFToken

+ const HeaderXContentTypeOptions

+ const HeaderXCorrelationID

+ const HeaderXForwardedFor

+ const HeaderXForwardedProto

+ const HeaderXForwardedProtocol

+ const HeaderXForwardedSsl

+ const HeaderXFrameOptions

+ const HeaderXHTTPMethodOverride

+ const HeaderXRealIP

+ const HeaderXRequestID

+ const HeaderXRequestedWith

+ const HeaderXUrlScheme

+ const HeaderXXSSProtection

+ const LoggerHostKey

+ const LoggerLatencyKey

+ const LoggerLocationKey

+ const LoggerMethodKey

+ const LoggerPanicKey

+ const LoggerParamsKey

+ const LoggerPathKey

+ const LoggerRouteKey

+ const LoggerSizeKey

+ const LoggerStatusKey

+ const MIMEApplicationForm

+ const MIMEApplicationJSON

+ const MIMEApplicationJSONCharsetUTF8

+ const MIMEApplicationJavaScript

+ const MIMEApplicationJavaScriptCharsetUTF8

+ const MIMEApplicationMsgpack

+ const MIMEApplicationProtobuf

+ const MIMEApplicationXML

+ const MIMEApplicationXMLCharsetUTF8

+ const MIMEMultipartForm

+ const MIMEOctetStream

+ const MIMETextHTML

+ const MIMETextHTMLCharsetUTF8

+ const MIMETextPlain

+ const MIMETextPlainCharsetUTF8

+ const MIMETextXML

+ const MIMETextXMLCharsetUTF8

+ var ErrDiscardedResponseWriter = errors.New("discarded response writer")

+ var ErrInvalidConfig = errors.New("invalid config")

+ var ErrInvalidMatcher = errors.New("invalid matcher")

+ var ErrInvalidRoute = errors.New("invalid route")

+ var ErrNoClientIPResolver = errors.New("no client ip resolver")

+ var ErrParamKeyTooLarge = errors.New("parameter key too large")

+ var ErrReadOnlyTxn = errors.New("write on read-only transaction")

+ var ErrRegexpNotAllowed = errors.New("regexp not allowed")

+ var ErrRouteConflict = errors.New("route conflict")

+ var ErrRouteNameExist = errors.New("route name already registered")

+ var ErrRouteNotFound = errors.New("route not found")

+ var ErrSettledTxn = errors.New("transaction settled")

+ var ErrTooManyMatchers = errors.New("too many matchers")

+ var ErrTooManyParams = errors.New("too many params")

+ var MethodAny []string

+ var MethodConnect = []string

+ var MethodDelete = []string

+ var MethodGet = []string

+ var MethodHead = []string

+ var MethodOptions = []string

+ var MethodPatch = []string

+ var MethodPost = []string

+ var MethodPut = []string

+ var MethodTrace = []string

+ func CleanPath(p string) string

+ func DefaultHandleRecovery(c *Context, _ any)

+ func DefaultMethodNotAllowedHandler(c *Context)

+ func DefaultNotFoundHandler(c *Context)

+ func DefaultOptionsHandler(c *Context)

+ func ErrNotSupported() error

+ func NewTestContext(w http.ResponseWriter, r *http.Request, opts ...GlobalOption) (*Router, *Context)

+ func WithClientIPMatcher(ip string) interface

+ func WithClientIPResolver(resolver ClientIPResolver) interface

+ func WithHandleTrailingSlash(opt TrailingSlashOption) interface

+ func WithHeaderMatcher(key, value string) interface

+ func WithHeaderRegexpMatcher(key, expr string) interface

+ func WithMatcher(matchers ...Matcher) interface

+ func WithMiddleware(m ...MiddlewareFunc) interface

+ func WithQueryMatcher(key, value string) interface

+ func WithQueryRegexpMatcher(key, expr string) interface

+ type ClientIPResolver interface

+ ClientIP func(c RequestContext) (*net.IPAddr, error)

+ type ClientIPResolverFunc func(c RequestContext) (*net.IPAddr, error)

+ func (f ClientIPResolverFunc) ClientIP(c RequestContext) (*net.IPAddr, error)

+ type ClientIpMatcher struct

+ func MatchClientIP(ip string) (ClientIpMatcher, error)

+ func (m ClientIpMatcher) Equal(matcher Matcher) bool

+ func (m ClientIpMatcher) IPNet() *net.IPNet

+ func (m ClientIpMatcher) Match(c RequestContext) bool

+ func (m ClientIpMatcher) String() string

+ type Context struct

+ func NewTestContextOnly(w http.ResponseWriter, r *http.Request, opts ...GlobalOption) *Context

+ func (c *Context) AddHeader(key, value string)

+ func (c *Context) Blob(code int, contentType string, buf []byte) (err error)

+ func (c *Context) ClientIP() (*net.IPAddr, error)

+ func (c *Context) Clone() *Context

+ func (c *Context) CloneWith(w ResponseWriter, r *http.Request) *Context

+ func (c *Context) Close()

+ func (c *Context) Header(key string) string

+ func (c *Context) Host() string

+ func (c *Context) Method() string

+ func (c *Context) Param(name string) string

+ func (c *Context) Params() iter.Seq[Param]

+ func (c *Context) Path() string

+ func (c *Context) Pattern() string

+ func (c *Context) QueryParam(name string) string

+ func (c *Context) QueryParams() url.Values

+ func (c *Context) RemoteIP() *net.IPAddr

+ func (c *Context) Request() *http.Request

+ func (c *Context) Route() *Route

+ func (c *Context) Router() *Router

+ func (c *Context) Scope() HandlerScope

+ func (c *Context) SetHeader(key, value string)

+ func (c *Context) SetRequest(r *http.Request)

+ func (c *Context) SetWriter(w ResponseWriter)

+ func (c *Context) Stream(code int, contentType string, r io.Reader) (err error)

+ func (c *Context) String(code int, s string) (err error)

+ func (c *Context) Writer() ResponseWriter

+ type FixedPathOption uint8

+ const RedirectPath

+ const RelaxedPath

+ const StrictPath

+ type GlobalOption interface

+ func AllowRegexpParam(enable bool) GlobalOption

+ func DefaultOptions() GlobalOption

+ func WithAutoOptions(enable bool) GlobalOption

+ func WithHandleFixedPath(opt FixedPathOption) GlobalOption

+ func WithMaxRouteMatchers(max int) GlobalOption

+ func WithMaxRouteParamKeyBytes(max int) GlobalOption

+ func WithMaxRouteParams(max int) GlobalOption

+ func WithMiddlewareFor(scope HandlerScope, m ...MiddlewareFunc) GlobalOption

+ func WithNoMethod(enable bool) GlobalOption

+ func WithNoMethodHandler(handler HandlerFunc) GlobalOption

+ func WithNoRouteHandler(handler HandlerFunc) GlobalOption

+ func WithOptionsHandler(handler HandlerFunc) GlobalOption

+ func WithPrettyLogs() GlobalOption

+ func WithSystemWideOptions(enable bool) GlobalOption

+ type HandlerFunc func(c *Context)

+ func Sub(router *Router) HandlerFunc

+ func WrapF(f http.HandlerFunc) HandlerFunc

+ func WrapH(h http.Handler) HandlerFunc

+ type HandlerScope uint8

+ const AllHandlers

+ const NoMethodHandler

+ const NoRouteHandler

+ const OptionsHandler

+ const RedirectPathHandler

+ const RedirectSlashHandler

+ const RouteHandler

+ type HeaderMatcher struct

+ func MatchHeader(key, value string) (HeaderMatcher, error)

+ func (m HeaderMatcher) Equal(matcher Matcher) bool

+ func (m HeaderMatcher) Key() string

+ func (m HeaderMatcher) Match(c RequestContext) bool

+ func (m HeaderMatcher) String() string

+ func (m HeaderMatcher) Value() string

+ type HeaderRegexpMatcher struct

+ func MatchHeaderRegexp(key, expr string) (HeaderRegexpMatcher, error)

+ func (m HeaderRegexpMatcher) Equal(matcher Matcher) bool

+ func (m HeaderRegexpMatcher) Key() string

+ func (m HeaderRegexpMatcher) Match(c RequestContext) bool

+ func (m HeaderRegexpMatcher) Regex() *regexp.Regexp

+ func (m HeaderRegexpMatcher) String() string

+ type Iter struct

+ func (it Iter) All() iter.Seq[*Route]

+ func (it Iter) Methods() iter.Seq[string]

+ func (it Iter) NamePrefix(prefix string) iter.Seq[*Route]

+ func (it Iter) Names() iter.Seq[*Route]

+ func (it Iter) PatternPrefix(prefix string) iter.Seq[*Route]

+ func (it Iter) Routes(pattern string) iter.Seq[*Route]

+ type Matcher interface

+ Equal func(m Matcher) bool

+ Match func(c RequestContext) bool

+ type MatcherOption interface

+ type MiddlewareFunc func(next HandlerFunc) HandlerFunc

+ func Logger(handler slog.Handler) MiddlewareFunc

+ func Recovery(handler slog.Handler) MiddlewareFunc

+ func RecoveryWithFunc(handler slog.Handler, handle RecoveryFunc) MiddlewareFunc

+ func WrapM(m func(http.Handler) http.Handler) MiddlewareFunc

+ type Param struct

+ Key string

+ Value string

+ type Params []Param

+ func ParamsFromContext(ctx context.Context) Params

+ func (p Params) Get(name string) string

+ func (p Params) Has(name string) bool

+ type QueryMatcher struct

+ func MatchQuery(key, value string) (QueryMatcher, error)

+ func (m QueryMatcher) Equal(matcher Matcher) bool

+ func (m QueryMatcher) Key() string

+ func (m QueryMatcher) Match(c RequestContext) bool

+ func (m QueryMatcher) String() string

+ func (m QueryMatcher) Value() string

+ type QueryRegexpMatcher struct

+ func MatchQueryRegexp(key, expr string) (QueryRegexpMatcher, error)

+ func (m QueryRegexpMatcher) Equal(matcher Matcher) bool

+ func (m QueryRegexpMatcher) Key() string

+ func (m QueryRegexpMatcher) Match(c RequestContext) bool

+ func (m QueryRegexpMatcher) Regex() *regexp.Regexp

+ func (m QueryRegexpMatcher) String() string

+ type RecoveryFunc func(c *Context, err any)

+ type RequestContext interface

+ ClientIP func() (*net.IPAddr, error)

+ Header func(key string) string

+ Host func() string

+ Method func() string

+ Path func() string

+ Pattern func() string

+ QueryParam func(name string) string

+ QueryParams func() url.Values

+ RemoteIP func() *net.IPAddr

+ Request func() *http.Request

+ type ResponseWriter interface

+ EnableFullDuplex func() error

+ FlushError func() error

+ Hijack func() (net.Conn, *bufio.ReadWriter, error)

+ Push func(target string, opts *http.PushOptions) error

+ SetReadDeadline func(deadline time.Time) error

+ SetWriteDeadline func(deadline time.Time) error

+ Size func() int

+ Status func() int

+ Written func() bool

+ type Route struct

+ func (r *Route) Annotation(key any) any

+ func (r *Route) ClientIPResolver() ClientIPResolver

+ func (r *Route) Handle(c *Context)

+ func (r *Route) HandleMiddleware(c *Context, _ ...struct{})

+ func (r *Route) Hostname() string

+ func (r *Route) Matchers() iter.Seq[Matcher]

+ func (r *Route) MatchersLen() int

+ func (r *Route) MatchersPriority() uint

+ func (r *Route) Methods() iter.Seq[string]

+ func (r *Route) Name() string

+ func (r *Route) Params() iter.Seq[string]

+ func (r *Route) ParamsLen() int

+ func (r *Route) Path() string

+ func (r *Route) Pattern() string

+ func (r *Route) String() string

+ func (r *Route) TrailingSlashOption() TrailingSlashOption

+ type RouteConflictError struct

+ Conflicts []*Route

+ New *Route

+ func (e *RouteConflictError) Error() string

+ func (e *RouteConflictError) Unwrap() error

+ type RouteMatch struct

+ Tsr bool

+ type RouteNameConflictError struct

+ Conflict *Route

+ New *Route

+ func (e *RouteNameConflictError) Error() string

+ func (e *RouteNameConflictError) Unwrap() error

+ type RouteOption interface

+ func WithAnnotation(key, value any) RouteOption

+ func WithMatcherPriority(priority uint) RouteOption

+ func WithName(name string) RouteOption

+ type Router struct

+ func MustRouter(opts ...GlobalOption) *Router

+ func NewRouter(opts ...GlobalOption) (*Router, error)

+ func (fox *Router) Add(methods []string, pattern string, handler HandlerFunc, opts ...RouteOption) (*Route, error)

+ func (fox *Router) AddRoute(route *Route) error

+ func (fox *Router) Delete(methods []string, pattern string, opts ...MatcherOption) (*Route, error)

+ func (fox *Router) DeleteRoute(route *Route) (*Route, error)

+ func (fox *Router) HandleNoRoute(c *Context)

+ func (fox *Router) Has(methods []string, pattern string, matchers ...Matcher) bool

+ func (fox *Router) Iter() Iter

+ func (fox *Router) Len() int

+ func (fox *Router) Lookup(w ResponseWriter, r *http.Request) (route *Route, cc *Context, tsr bool)

+ func (fox *Router) Match(method string, r *http.Request) (route *Route, tsr bool)

+ func (fox *Router) MustAdd(methods []string, pattern string, handler HandlerFunc, opts ...RouteOption) *Route

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

+ func (fox *Router) NewRoute(methods []string, pattern string, handler HandlerFunc, opts ...RouteOption) (*Route, error)

+ func (fox *Router) Route(methods []string, pattern string, matchers ...Matcher) *Route

+ func (fox *Router) RouterInfo() RouterInfo

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

+ func (fox *Router) Txn(write bool) *Txn

+ func (fox *Router) Update(methods []string, pattern string, handler HandlerFunc, opts ...RouteOption) (*Route, error)

+ func (fox *Router) UpdateRoute(route *Route) error

+ func (fox *Router) Updates(fn func(txn *Txn) error) error

+ func (fox *Router) View(fn func(txn *Txn) error) error

+ type RouterInfo struct

+ AllowRegexp bool

+ AutoOptions bool

+ ClientIP bool

+ FixedPathOption FixedPathOption

+ MaxRouteMatchers int

+ MaxRouteParamKeyBytes int

+ MaxRouteParams int

+ MethodNotAllowed bool

+ SystemWideOptions bool

+ TrailingSlashOption TrailingSlashOption

+ type TrailingSlashOption uint8

+ const RedirectSlash

+ const RelaxedSlash

+ const StrictSlash

+ type Txn struct

+ func (txn *Txn) Abort()

+ func (txn *Txn) Add(methods []string, pattern string, handler HandlerFunc, opts ...RouteOption) (*Route, error)

+ func (txn *Txn) AddRoute(route *Route) error

+ func (txn *Txn) Commit()

+ func (txn *Txn) Delete(methods []string, pattern string, opts ...MatcherOption) (*Route, error)

+ func (txn *Txn) DeleteRoute(route *Route) (*Route, error)

+ func (txn *Txn) Has(methods []string, pattern string, matchers ...Matcher) bool

+ func (txn *Txn) Iter() Iter

+ func (txn *Txn) Len() int

+ func (txn *Txn) Lookup(w ResponseWriter, r *http.Request) (route *Route, cc *Context, tsr bool)

+ func (txn *Txn) Match(method string, r *http.Request) (route *Route, tsr bool)

+ func (txn *Txn) Name(name string) *Route

+ func (txn *Txn) Route(methods []string, pattern string, matchers ...Matcher) *Route

+ func (txn *Txn) Snapshot() *Txn

+ func (txn *Txn) Truncate() error

+ func (txn *Txn) Update(methods []string, pattern string, handler HandlerFunc, opts ...RouteOption) (*Route, error)

+ func (txn *Txn) UpdateRoute(route *Route) error