zen

package module

Go to main page

Versions in this module

v1

v1.4.0

Jul 31, 2026

Changes in this version

+ const HeaderXRequestID

+ func BindBody(c *Ctx, dest any) error

+ func BindHeaders(c *Ctx, dest any) error

+ func BindPathValues(c *Ctx, dest any) error

+ func BindQueryParams(c *Ctx, dest any) error

+ func RenderWriter(w io.Writer, tmpl *Templates, name string, data any) error

+ type BindMultipleUnmarshaler interface

+ UnmarshalParams func(params []string) error

+ type BindUnmarshaler interface

+ UnmarshalParam func(param string) error

type Ctx

+ func (c *Ctx) ClientIP() string

+ func (c *Ctx) ContentType() string

+ func (c *Ctx) DefaultParam(key, defaultVal string) string

+ func (c *Ctx) DefaultQuery(key, defaultVal string) string

+ func (c *Ctx) IsAjax() bool

+ func (c *Ctx) JSONPretty(status int, data any)

+ func (c *Ctx) Params() map[string]string

+ func (c *Ctx) QueryParams() map[string][]string

+ func (c *Ctx) Render(status int, tmpl *Templates, name string, data any)

+ func (c *Ctx) Validate(dest any) error

type Engine

+ JSONSerializer JSONSerializer

+ MaxMultipartMemory int64

+ XMLSerializer XMLSerializer

+ func (e *Engine) DefaultValidator() *validator.Validate

+ func (e *Engine) EnableAutoValidation()

+ func (e *Engine) NoMethod(handlers ...HandlerFunc)

+ func (e *Engine) NoRoute(handlers ...HandlerFunc)

+ func (e *Engine) SetValidator(v Validator)

+ func (e *Engine) Validate(dest any) error

+ type JSONSerializer interface

+ Deserialize func(c *Ctx, v any) error

+ Serialize func(c *Ctx, v any, indent string) error

+ type Templates struct

+ func LoadTemplates(fsys fs.FS, pattern string) (*Templates, error)

+ type TestRequest struct

+ Request *http.Request

+ Response *httptest.ResponseRecorder

+ func NewTestRequest(method, path string, body io.Reader) *TestRequest

+ func NewTestRequestWithJSON(method, path, jsonBody string) *TestRequest

+ func (tr *TestRequest) Serve(r *Engine)

+ type ValidatorFunc func(i any) error

+ func (f ValidatorFunc) Validate(i any) error

+ type XMLSerializer interface

+ Deserialize func(c *Ctx, v any) error

+ Serialize func(c *Ctx, v any) error

v1.3.0

Jul 10, 2026

Changes in this version

+ func EnableAutoValidation()

v1.2.0

May 30, 2026

retracted

Changes in this version

+ var ErrFlusherUnsupported = errors.New("sse: SSE requires http.Flusher")

+ func BytesToString(b []byte) string

+ func DefaultValidator() *validator.Validate

+ func DisableAutoValidation()

+ func SetValidator(v Validator)

+ func StringToBytes(s string) []byte

+ func Validate(dest any) error

+ type Config struct

+ IdleTimeout time.Duration

+ MaxHeaderBytes int

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ ShutdownTimeout time.Duration

+ WriteTimeout time.Duration

+ func DefaultConfig() Config

+ type Ctx struct

+ Request *http.Request

+ Response http.ResponseWriter

+ func FromContext(ctx context.Context) (*Ctx, bool)

+ func (c *Ctx) Attachment(filePath, attachmentName string)

+ func (c *Ctx) Bind(dest any) error

+ func (c *Ctx) BindBody(dest any) error

+ func (c *Ctx) BindForm(dest any) error

+ func (c *Ctx) BindHeader(dest any) error

+ func (c *Ctx) BindJSON(dest any) error

+ func (c *Ctx) BindPathParams(dest any) error

+ func (c *Ctx) BindQueryParams(dest any) error

+ func (c *Ctx) BindXML(dest any) error

+ func (c *Ctx) Blob(status int, contentType string, data []byte)

+ func (c *Ctx) Body() ([]byte, error)

+ func (c *Ctx) Copy() *Ctx

+ func (c *Ctx) Error(status int, message string)

+ func (c *Ctx) File(filePath string)

+ func (c *Ctx) FormFile(fieldName string) (*multipart.FileHeader, multipart.File, error)

+ func (c *Ctx) FormFiles(fieldName string) ([]*multipart.FileHeader, error)

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

+ func (c *Ctx) HTML(status int, html string)

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

+ func (c *Ctx) Inline(filePath string)

+ func (c *Ctx) JSON(status int, data any)

+ func (c *Ctx) Keys() map[string]any

+ func (c *Ctx) Next()

+ func (c *Ctx) Param(key string) string

+ func (c *Ctx) QueryParam(key string) string

+ func (c *Ctx) ReadFile(fieldName string) (header *multipart.FileHeader, content []byte, err error)

+ func (c *Ctx) Redirect(status int, location string)

+ func (c *Ctx) SSEvent(event string, data any) error

+ func (c *Ctx) Set(key string, val any)

+ func (c *Ctx) Status(status int)

+ func (c *Ctx) Stream(status int, contentType string, body io.Reader) error

+ func (c *Ctx) String(status int, text string)

+ func (c *Ctx) XML(status int, data any)

+ type Engine struct

+ Mux *http.ServeMux

+ func (e *Engine) File(pattern, filePath string)

+ func (e *Engine) Run()

+ func (e *Engine) RunTLS(certFile, keyFile string)

+ func (e *Engine) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (e *Engine) Static(prefix, root string)

+ func (e *Engine) StaticFS(prefix string, filesystem fs.FS)

+ type HandlerFunc func(*Ctx)

+ type RouterGroup struct

+ func (g *RouterGroup) DELETE(path string, handlers ...HandlerFunc)

+ func (g *RouterGroup) GET(path string, handlers ...HandlerFunc)

+ func (g *RouterGroup) Group(prefix string, middleware ...HandlerFunc) *RouterGroup

+ func (g *RouterGroup) HEAD(path string, handlers ...HandlerFunc)

+ func (g *RouterGroup) HandleRaw(pattern string, handler http.Handler)

+ func (g *RouterGroup) OPTIONS(path string, handlers ...HandlerFunc)

+ func (g *RouterGroup) PATCH(path string, handlers ...HandlerFunc)

+ func (g *RouterGroup) POST(path string, handlers ...HandlerFunc)

+ func (g *RouterGroup) PUT(path string, handlers ...HandlerFunc)

+ func (g *RouterGroup) Prefix() string

+ func (g *RouterGroup) Use(middleware ...HandlerFunc)

+ type SkipFunc func(*http.Request) bool

+ type Validator interface

+ Validate func(i any) error

v1.0.3

Mar 20, 2026

retracted

Changes in this version

+ var ErrInvalidBindTarget = errors.New("zen: BindForm dest must be a pointer to a struct")

+ type Context struct

+ Request *http.Request

+ Response http.ResponseWriter

+ func FromRequest(r *http.Request) *Context

+ func (c *Context) BindForm(dest any) error

+ func (c *Context) BindJSON(dest any) error

+ func (c *Context) Body() ([]byte, error)

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

+ func (c *Context) JSON(status int, data any)

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

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

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

+ type FormError struct

+ Err error

+ Field string

+ func (e *FormError) Error() string

+ func (e *FormError) Unwrap() error

+ type MiddlewareFunc func(*Context, http.Handler)

+ type Router struct

+ func New(addr string) *Router

+ func (s *Router) Handle(pattern string, handler func(*Context))

+ func (s *Router) HandleRaw(pattern string, handler http.Handler)

+ func (s *Router) ListenAndServe()

+ func (s *Router) ListenAndServeTLS(certFile, keyFile string)

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

+ func (s *Router) Use(m ...MiddlewareFunc)

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