rig

package module

Go to main page

Versions in this module

v1

v1.10.0

Jan 6, 2026

v1.9.0

Jan 6, 2026

Changes in this version

+ type StaticConfig struct

+ CacheControl string

v1.8.0

Jan 6, 2026

Changes in this version

+ type LogFunc func(format string, args ...any)

type MiddlewareFunc

+ func RecoverWithConfig(config RecoverConfig) MiddlewareFunc

+ type RecoverConfig struct

+ Logger func(err any, stack []byte)

type ServerConfig

+ Logger LogFunc

v1.7.0

Jan 6, 2026

Changes in this version

type Router

+ func (r *Router) RunGracefully(addr string) error

+ func (r *Router) RunWithGracefulShutdown(config ServerConfig) error

type ServerConfig

+ ShutdownTimeout time.Duration

v1.6.0

Jan 6, 2026

Changes in this version

+ type CheckFuncContext func(ctx context.Context) error

type Health

+ func NewHealthWithConfig(config HealthConfig) *Health

+ func (h *Health) AddLivenessCheckContext(name string, check CheckFuncContext)

+ func (h *Health) AddLivenessCheckWithTimeout(name string, timeout time.Duration, check CheckFuncContext)

+ func (h *Health) AddReadinessCheckContext(name string, check CheckFuncContext)

+ func (h *Health) AddReadinessCheckWithTimeout(name string, timeout time.Duration, check CheckFuncContext)

+ type HealthConfig struct

+ CheckTimeout time.Duration

+ Parallel bool

+ func DefaultHealthConfig() HealthConfig

type MiddlewareFunc

+ func Timeout(d time.Duration) MiddlewareFunc

+ func TimeoutWithConfig(config TimeoutConfig) MiddlewareFunc

type Router

+ func (r *Router) RunUnsafe(addr string) error

+ func (r *Router) RunWithConfig(config ServerConfig) error

+ type ServerConfig struct

+ Addr string

+ IdleTimeout time.Duration

+ MaxHeaderBytes int

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ WriteTimeout time.Duration

+ func DefaultServerConfig() ServerConfig

+ type TimeoutConfig struct

+ OnTimeout func(c *Context) error

+ Timeout time.Duration

v1.5.0

Jan 5, 2026

v1.4.0

Dec 25, 2025

v1.3.0

Dec 25, 2025

v1.2.0

Dec 24, 2025

v1.1.1

Dec 4, 2025

v1.1.0

Dec 4, 2025

Changes in this version

+ type CheckFunc func() error

+ type Health struct

+ func NewHealth() *Health

+ func (h *Health) AddLivenessCheck(name string, check CheckFunc)

+ func (h *Health) AddReadinessCheck(name string, check CheckFunc)

+ func (h *Health) LiveHandler() HandlerFunc

+ func (h *Health) ReadyHandler() HandlerFunc

v1.0.0

Dec 4, 2025

Changes in this version

+ func DefaultErrorHandler(c *Context, err error)

+ func GetType[T any](c *Context, key string) (T, error)

+ type CORSConfig struct

+ AllowHeaders []string

+ AllowMethods []string

+ AllowOrigins []string

+ type Context struct

+ func (c *Context) Bind(v any) error

+ func (c *Context) BindStrict(v any) error

+ func (c *Context) Context() context.Context

+ func (c *Context) Data(code int, contentType string, data []byte)

+ func (c *Context) File(filepath string)

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

+ func (c *Context) Get(key string) (any, bool)

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

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

+ func (c *Context) JSON(code int, v any) error

+ func (c *Context) Method() string

+ func (c *Context) MustGet(key string) any

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

+ func (c *Context) Path() string

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

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

+ func (c *Context) QueryArray(key string) []string

+ func (c *Context) QueryDefault(key, defaultValue string) string

+ func (c *Context) Redirect(code int, url string)

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

+ func (c *Context) Set(key string, value any)

+ func (c *Context) SetContext(ctx context.Context)

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

+ func (c *Context) Status(code int)

+ func (c *Context) Write(data []byte) (int, error)

+ func (c *Context) WriteString(s string) (int, error)

+ func (c *Context) Writer() http.ResponseWriter

+ func (c *Context) Written() bool

+ type ErrorHandler func(*Context, error)

+ type HandlerFunc func(*Context) error

+ type MiddlewareFunc func(HandlerFunc) HandlerFunc

+ func CORS(config CORSConfig) MiddlewareFunc

+ func DefaultCORS() MiddlewareFunc

+ func Recover() MiddlewareFunc

+ type RouteGroup struct

+ func (g *RouteGroup) DELETE(path string, handler HandlerFunc)

+ func (g *RouteGroup) GET(path string, handler HandlerFunc)

+ func (g *RouteGroup) Group(prefix string) *RouteGroup

+ func (g *RouteGroup) PATCH(path string, handler HandlerFunc)

+ func (g *RouteGroup) POST(path string, handler HandlerFunc)

+ func (g *RouteGroup) PUT(path string, handler HandlerFunc)

+ func (g *RouteGroup) Use(mw ...MiddlewareFunc)

+ type Router struct

+ func New() *Router

+ func (r *Router) DELETE(path string, handler HandlerFunc)

+ func (r *Router) GET(path string, handler HandlerFunc)

+ func (r *Router) Group(prefix string) *RouteGroup

+ func (r *Router) HEAD(path string, handler HandlerFunc)

+ func (r *Router) Handle(pattern string, handler HandlerFunc)

+ func (r *Router) Handler() http.Handler

+ func (r *Router) OPTIONS(path string, handler HandlerFunc)

+ func (r *Router) PATCH(path string, handler HandlerFunc)

+ func (r *Router) POST(path string, handler HandlerFunc)

+ func (r *Router) PUT(path string, handler HandlerFunc)

+ func (r *Router) Run(addr string) error

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

+ func (r *Router) SetErrorHandler(handler ErrorHandler)

+ func (r *Router) Static(path, root string)

+ func (r *Router) Use(mw ...MiddlewareFunc)

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