fox

package module

Go to main page

Versions in this module

v0

v0.22.1

Feb 28, 2025

v0.22.0

Feb 2, 2025

Changes in this version

type Context

+ Method func() string

type TestContext

+ func (c TestContext) Method() string

v0.21.0

Jan 30, 2025

Changes in this version

+ const HeaderHost

type Route

+ func (r *Route) ClientIPResolver() ClientIPResolver

+ func (r *Route) ParamsLen() int

type Router

+ func (fox *Router) HandleRoute(method string, route *Route) error

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

+ func (fox *Router) UpdateRoute(method string, route *Route) error

+ type TestContext struct

+ func (c *TestContext) SetParams(params Params)

+ func (c *TestContext) SetRoute(route *Route)

+ func (c *TestContext) SetScope(scope HandlerScope)

+ func (c TestContext) AddHeader(key, value string)

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

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

+ func (c TestContext) Clone() Context

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

+ func (c TestContext) Close()

+ func (c TestContext) Fox() *Router

+ func (c TestContext) Header(key string) string

+ func (c TestContext) Host() string

+ func (c TestContext) Param(name string) string

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

+ func (c TestContext) Path() string

+ func (c TestContext) Pattern() string

+ func (c TestContext) QueryParam(name string) string

+ func (c TestContext) QueryParams() url.Values

+ func (c TestContext) Redirect(code int, url string) error

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

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

+ func (c TestContext) Route() *Route

+ func (c TestContext) Scope() HandlerScope

+ func (c TestContext) SetHeader(key, value string)

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

+ func (c TestContext) SetWriter(w ResponseWriter)

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

+ func (c TestContext) String(code int, format string, values ...any) (err error)

+ func (c TestContext) Writer() ResponseWriter

type Txn

+ func (txn *Txn) HandleRoute(method string, route *Route) error

+ func (txn *Txn) UpdateRoute(method string, route *Route) error

v0.20.1

Jan 25, 2025

v0.20.0

Jan 24, 2025

Changes in this version

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

type Route

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

v0.19.0

Nov 30, 2024

Changes in this version

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

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

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

+ type ClientIPResolver interface

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

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

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

type GlobalOption

+ func WithMaxRouteParamKeyBytes(max uint16) GlobalOption

+ func WithMaxRouteParams(max uint16) GlobalOption

type Option

+ func WithClientIPResolver(resolver ClientIPResolver) Option

type ResponseWriter

+ EnableFullDuplex func() error

type Route

+ func (r *Route) ClientIPResolverEnabled() bool

type Router

+ func (fox *Router) Len() int

+ func (fox *Router) Stats() RouterInfo

+ type RouterInfo struct

+ AutoOptions bool

+ ClientIP bool

+ IgnoreTrailingSlash bool

+ MaxRouteParamKeyBytes uint16

+ MaxRouteParams uint16

+ MethodNotAllowed bool

+ RedirectTrailingSlash bool

type Txn

+ func (txn *Txn) Len() int

v0.18.1

Nov 26, 2024

Changes in this version

type GlobalOption

+ func WithMaxParamKeyBytes(max uint16) GlobalOption

+ func WithMaxParams(max uint16) GlobalOption

v0.18.0

Nov 22, 2024

Changes in this version

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

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

+ func SplitHostPath(url string) (host, path string)

type Context

+ AddHeader func(key, value string)

+ Host func() string

+ Pattern func() string

type Route

+ func (r *Route) Hostname() string

+ func (r *Route) Pattern() string

+ type RouteOption interface

type Router

+ func (fox *Router) Has(method, pattern string) bool

+ func (fox *Router) Reverse(method, host, path string) (route *Route, tsr bool)

+ func (fox *Router) Route(method, pattern string) *Route

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

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

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

+ type Txn struct

+ func (txn *Txn) Abort()

+ func (txn *Txn) Commit()

+ func (txn *Txn) Delete(method, pattern string) error

+ func (txn *Txn) Handle(method, pattern string, handler HandlerFunc, opts ...RouteOption) (*Route, error)

+ func (txn *Txn) Has(method, pattern string) bool

+ func (txn *Txn) Iter() Iter

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

+ func (txn *Txn) Reverse(method, host, path string) (route *Route, tsr bool)

+ func (txn *Txn) Route(method, pattern string) *Route

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

+ func (txn *Txn) Truncate(methods ...string) error

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

v0.17.1

Oct 16, 2024

Changes in this version

+ var ErrConcurrentAccess = errors.New("concurrent access violation: multiple writes detected on tree")

v0.17.0

Oct 15, 2024

Changes in this version

+ type Annotation struct

+ Key string

+ Value any

+ type Annotations []Annotation

type Context

+ Rehydrate func(route *Route) bool

+ Route func() *Route

+ Scope func() HandlerScope

+ type HandlerScope uint8

+ const RouteHandler

type PathOption

+ func WithAnnotation(key string, value any) PathOption

+ func WithAnnotations(annotations ...Annotation) PathOption

type Route

+ func (r *Route) Annotations() iter.Seq[Annotation]

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

type Tree

+ func (t *Tree) Delete(method, path string) error

v0.16.0

Oct 9, 2024

Changes in this version

+ func ErrNotSupported() error

+ func FixTrailingSlash(path string) string

+ type GlobalOption interface

+ type Iter struct

+ func (it Iter) All() iter.Seq2[string, *Route]

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

+ func (it Iter) Prefix(methods iter.Seq[string], prefix string) iter.Seq2[string, *Route]

+ func (it Iter) Reverse(methods iter.Seq[string], path string) iter.Seq2[string, *Route]

+ func (it Iter) Routes(methods iter.Seq[string], path string) iter.Seq2[string, *Route]

+ type PathOption interface

type ResponseWriter

+ SetReadDeadline func(deadline time.Time) error

+ SetWriteDeadline func(deadline time.Time) error

+ type Route struct

+ func (r *Route) ClientIPStrategyEnabled() bool

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

+ func (r *Route) IgnoreTrailingSlashEnabled() bool

+ func (r *Route) Path() string

+ func (r *Route) RedirectTrailingSlashEnabled() bool

type Router

+ func (fox *Router) Iter() Iter

type Tree

+ func (t *Tree) Iter() Iter

+ func (t *Tree) Reverse(method, path string) (route *Route, tsr bool)

+ func (t *Tree) Route(method, path string) *Route

v0.15.0

Jul 15, 2024

v0.14.0

Jul 4, 2024

Changes in this version

+ const HeaderCFConnectionIP

+ const HeaderFastClientIP

+ const HeaderFlyClientIP

+ const HeaderForwarded

+ const HeaderProxyAuthorization

+ const HeaderTrueClientIP

+ const HeaderXAppengineRemoteAddr

+ const HeaderXAzureClientIP

+ const HeaderXAzureSocketIP

+ var ErrNoClientIPStrategy = errors.New("no client ip strategy")

+ type ClientIPStrategy interface

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

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

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

type Context

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

+ RemoteIP func() *net.IPAddr

type MiddlewareFunc

+ func CustomRecovery(handle RecoveryFunc) MiddlewareFunc

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

+ func Logger() MiddlewareFunc

+ func LoggerWithHandler(handler slog.Handler) MiddlewareFunc

type Option

+ func WithClientIPStrategy(strategy ClientIPStrategy) Option

+ func WithIgnoreTrailingSlash(enable bool) Option

type Router

+ func (fox *Router) AutoOptionsEnabled() bool

+ func (fox *Router) ClientIPStrategyEnabled() bool

+ func (fox *Router) IgnoreTrailingSlashEnabled() bool

+ func (fox *Router) MethodNotAllowedEnabled() bool

+ func (fox *Router) RedirectTrailingSlashEnabled() bool

v0.13.0

Feb 27, 2024

Changes in this version

type HandlerFunc

+ func DefaultOptionsHandler() HandlerFunc

type ResponseWriter

+ FlushError func() error

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

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

type Tree

+ func (t *Tree) Match(method, path string) string

v0.12.0

Jan 24, 2024

v0.11.0

Aug 17, 2023

Changes in this version

type Context

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

v0.10.0

Jul 19, 2023

v0.9.5

Jul 13, 2023

Changes in this version

type HandlerFunc

+ func WrapTestContextFlusher(next HandlerFunc) HandlerFunc

v0.9.4

Jun 30, 2023

v0.9.3

Jun 28, 2023

v0.9.2

Jun 15, 2023

Changes in this version

+ var ErrInvalidCtxParams = errors.New("unable to get params from context")

type Params

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

v0.9.1

Jun 7, 2023

Changes in this version

type ResponseWriter

+ Wrap func(w http.ResponseWriter)

v0.9.0

Jun 6, 2023

Changes in this version

type Context

+ TeeWriter func(w io.Writer)

type HandlerFunc

+ func WrapTestContext(next HandlerFunc) HandlerFunc

type MiddlewareScope

+ const NoMethodHandler

+ const NoRouteHandler

+ const OptionsHandler

type Option

+ func WithAutoOptions(enable bool) Option

+ func WithNoMethod(enable bool) Option

+ func WithNoMethodHandler(handler HandlerFunc) Option

+ func WithNoRouteHandler(handler HandlerFunc) Option

+ func WithOptionsHandler(handler HandlerFunc) Option

type Tree

+ func (t *Tree) LookupMethods(path string) (methods []string)

v0.8.1

May 10, 2023

v0.8.0

Apr 20, 2023

Changes in this version

type Context

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

type Tree

+ func (t *Tree) Has(method, path string) bool

+ func (t *Tree) Lookup(method, path string, lazy bool) (handler HandlerFunc, cc ContextCloser, tsr bool)

v0.7.6

Apr 17, 2023

Changes in this version

type HandlerFunc

+ func DefaultMethodNotAllowedHandler() HandlerFunc

+ func DefaultNotFoundHandler() HandlerFunc

+ type MiddlewareScope uint8

+ const AllHandlers

+ const RedirectHandler

+ const RouteHandlers

type Option

+ func WithMethodNotAllowedHandler(handler HandlerFunc) Option

+ func WithMiddlewareFor(scope MiddlewareScope, m ...MiddlewareFunc) Option

v0.7.5

Apr 13, 2023

v0.7.4

Apr 12, 2023

Changes in this version

+ func HandleRecovery(c Context, err any)

type Tree

+ func (t *Tree) Methods() []string

v0.7.3

Apr 10, 2023

Changes in this version

type Context

+ SetHeader func(key, value string)

v0.7.2

Apr 10, 2023

Changes in this version

+ const HeaderETag

+ func DefaultHandleRecovery(c Context, err any)

type Context

+ Ctx func() ctx.Context

+ GetHeader func(key string) string

+ Header func(key, value string)

type ResponseWriter

+ WriteString func(s string) (int, error)

v0.7.1

Apr 9, 2023

v0.7.0

Apr 9, 2023

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 HeaderCacheControl

+ const HeaderConnection

+ const HeaderContentDisposition

+ const HeaderContentEncoding

+ const HeaderContentLength

+ const HeaderContentSecurityPolicy

+ const HeaderContentSecurityPolicyReportOnly

+ const HeaderContentType

+ const HeaderCookie

+ const HeaderIfModifiedSince

+ const HeaderLastModified

+ const HeaderLocation

+ const HeaderOrigin

+ const HeaderReferrerPolicy

+ const HeaderRetryAfter

+ const HeaderServer

+ const HeaderSetCookie

+ const HeaderStrictTransportSecurity

+ const HeaderUpgrade

+ const HeaderVary

+ const HeaderWWWAuthenticate

+ 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 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 ErrInvalidRedirectCode = errors.New("invalid redirect code")

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

+ type Context interface

+ Blob func(code int, contentType string, buf []byte) error

+ Clone func() Context

+ Done func() <-chan struct{}

+ Fox func() *Router

+ Param func(name string) string

+ Params func() Params

+ Path func() string

+ QueryParam func(name string) string

+ QueryParams func() url.Values

+ Redirect func(code int, url string) error

+ Request func() *http.Request

+ SetRequest func(r *http.Request)

+ SetWriter func(w ResponseWriter)

+ Stream func(code int, contentType string, r io.Reader) error

+ String func(code int, format string, values ...any) error

+ Tree func() *Tree

+ Writer func() ResponseWriter

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

+ type ContextCloser interface

+ Close func()

+ type ErrorHandlerFunc func(c Context, err error)

+ func RouteErrorHandler() ErrorHandlerFunc

+ type HTTPError struct

+ Code int

+ Err error

+ func NewHTTPError(code int, err ...error) HTTPError

+ func (e HTTPError) Error() string

type HandlerFunc

+ func MethodNotAllowedHandler() HandlerFunc

+ func NotFoundHandler() HandlerFunc

+ type MiddlewareFunc func(next HandlerFunc) HandlerFunc

+ func Recovery(handle RecoveryFunc) MiddlewareFunc

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

type Option

+ func DefaultOptions() Option

+ func WithMethodNotAllowed(handler HandlerFunc, m ...MiddlewareFunc) Option

+ func WithMiddleware(m ...MiddlewareFunc) Option

+ func WithRouteError(handler ErrorHandlerFunc) Option

+ func WithRouteNotFound(handler HandlerFunc, m ...MiddlewareFunc) Option

+ type RecoveryFunc func(c Context, err any)

+ type ResponseWriter interface

+ Size func() int

+ Status func() int

+ Unwrap func() http.ResponseWriter

+ Written func() bool

type Router

+ func (fox *Router) Handle(method, path string, handler HandlerFunc) error

+ func (fox *Router) MustHandle(method, path string, handler HandlerFunc)

type Tree

+ func (t *Tree) Handle(method, path string, handler HandlerFunc) error

v0.6.0

Apr 1, 2023

v0.5.0

Mar 27, 2023

Changes in this version

+ func Has(t *Tree, method, path string) bool

+ func Lookup(t *Tree, method, path string, lazy bool) (handler Handler, params *Params, tsr bool)

+ func Reverse(t *Tree, method, path string) string

+ func Walk(tree *Tree, fn WalkFunc) error

type Iterator

+ func NewIterator(t *Tree) *Iterator

+ type Option interface

+ func WithHandleMethodNotAllowed(enable bool) Option

+ func WithNotAllowedHandler(handler http.Handler) Option

+ func WithNotFoundHandler(handler http.Handler) Option

+ func WithPanicHandler(fn func(http.ResponseWriter, *http.Request, interface{})) Option

+ func WithRedirectFixedPath(enable bool) Option

+ func WithRedirectTrailingSlash(enable bool) Option

+ func WithSaveMatchedRoute(enable bool) Option

type Params

+ func (p *Params) Free(t *Tree)

type Router

+ func (fox *Router) NewTree() *Tree

+ func (fox *Router) Swap(new *Tree) (old *Tree)

+ func (fox *Router) Tree() *Tree

+ func (fox *Router) Use(new *Tree)

+ type Tree struct

+ func (t *Tree) Handler(method, path string, handler Handler) error

+ func (t *Tree) Remove(method, path string) error

+ func (t *Tree) Update(method, path string, handler Handler) error

v0.4.0

Jan 4, 2023

Changes in this version

+ type LockedRouter struct

+ func (lr *LockedRouter) Handler(method, path string, handler Handler) error

+ func (lr *LockedRouter) Lookup(method, path string, lazy bool, ...)

+ func (lr *LockedRouter) Match(method, path string) bool

+ func (lr *LockedRouter) NewIterator() *Iterator

+ func (lr *LockedRouter) Release()

+ func (lr *LockedRouter) Remove(method, path string) error

+ func (lr *LockedRouter) Update(method, path string, handler Handler) error

type Router

+ func (fox *Router) LockRouter() *LockedRouter

v0.3.0

Nov 28, 2022

Changes in this version

+ var SkipMethod = errors.New("skip method")

+ type Iterator struct

+ func (it *Iterator) Handler() Handler

+ func (it *Iterator) Method() string

+ func (it *Iterator) Next()

+ func (it *Iterator) Path() string

+ func (it *Iterator) Rewind()

+ func (it *Iterator) SeekMethod(method string)

+ func (it *Iterator) SeekMethodPrefix(method, key string)

+ func (it *Iterator) SeekPrefix(key string)

+ func (it *Iterator) Valid() bool

type Router

+ func (fox *Router) NewIterator() *Iterator

+ func (fox *Router) Walk(fn WalkFunc) error

v0.2.0

Nov 26, 2022

v0.1.0

Nov 25, 2022

Changes in this version

+ const RouteKey

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

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

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

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

+ var ErrSkipMethod = errors.New("skip method")

+ var ParamsKey = key

+ func CleanPath(p string) string

+ type Handler interface

+ ServeHTTP func(w http.ResponseWriter, r *http.Request, params Params)

+ func WrapF(f http.HandlerFunc) Handler

+ func WrapH(h http.Handler) Handler

+ type HandlerFunc func(w http.ResponseWriter, r *http.Request, params Params)

+ func (f HandlerFunc) ServeHTTP(w http.ResponseWriter, r *http.Request, params Params)

+ type Param struct

+ Key string

+ Value string

+ type Params []Param

+ func ParamsFromContext(ctx context.Context) Params

+ func (p *Params) Clone() Params

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

+ type RouteConflictError struct

+ Matched []string

+ Method string

+ Path string

+ func (e *RouteConflictError) Error() string

+ func (e *RouteConflictError) Unwrap() error

+ type Router struct

+ AddRouteParam bool

+ HandleMethodNotAllowed bool

+ MethodNotAllowed http.Handler

+ NotFound http.Handler

+ PanicHandler func(http.ResponseWriter, *http.Request, interface{})

+ RedirectFixedPath bool

+ RedirectTrailingSlash bool

+ func New() *Router

+ func (fox *Router) Delete(path string, handler Handler) error

+ func (fox *Router) Get(path string, handler Handler) error

+ func (fox *Router) Handler(method, path string, handler Handler) error

+ func (fox *Router) Lookup(method, path string, fn func(handler Handler, params Params, tsr bool))

+ func (fox *Router) Match(method, path string) bool

+ func (fox *Router) Post(path string, handler Handler) error

+ func (fox *Router) Put(path string, handler Handler) error

+ func (fox *Router) Remove(method, path string) error

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

+ func (fox *Router) Update(method, path string, handler Handler) error

+ func (fox *Router) Upsert(method, path string, handler Handler) error

+ func (fox *Router) WalkRoute(fn WalkFunc) error

+ type WalkFunc func(method, path string, handler Handler) error

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