xin

package

Go to main page

Versions in this module

v1

v1.2.11

Dec 23, 2025

v1.2.10

Dec 9, 2025

v1.2.9

Nov 25, 2025

Changes in this version

+ func Nop(c *Context)

type Context

+ Context context.Context

v1.2.8

Nov 8, 2025

Changes in this version

+ var DefaultRemoteIPHeaders = []string

+ var DefaultSSLProxyHeaders = map[string]string

+ var DefaultTrustedProxies = netx.IntranetCIDRs

+ func DisableAcceptRanges(c *Context)

type CacheControlSetter

+ Overwrite bool

v1.2.7

Oct 13, 2025

v1.2.6

Sep 27, 2025

Changes in this version

+ var BrokenPipeErrors = []string

v1.2.5

Sep 17, 2025

v1.2.4

Sep 14, 2025

Changes in this version

type Context

+ func (c *Context) FileFS(fs http.FileSystem, filepath string)

+ func (c *Context) FileFSAttachment(fs http.FileSystem, filepath, filename string)

v1.2.3

Aug 26, 2025

Changes in this version

type Engine

+ HTMLRenderer render.HTMLRenderer

v1.2.2

Aug 20, 2025

v1.0.27

Aug 16, 2025

Changes in this version

type Context

+ func (c *Context) BindBodyWithPlain(obj any) error

+ func (c *Context) MustBindPlain(obj any) error

+ func (c *Context) RequestHostname() string

+ func (c *Context) SetError(errs ...error)

+ func (c *Context) ShouldBindPlain(obj any) error

v1.0.26

Sep 20, 2024

Changes in this version

+ var IntranetCIDRs = []string

+ func IsAjax(c *Context) bool

v1.0.25

Aug 16, 2024

v1.0.24

Aug 14, 2024

v1.0.23

Aug 11, 2024

v1.0.22

Jul 27, 2024

v1.0.21

Jun 30, 2024

v1.0.20

Jun 13, 2024

v1.0.19

Jun 8, 2024

v1.0.18

Jun 3, 2024

v1.0.17

May 22, 2024

v1.0.16

May 8, 2024

v1.0.15

Apr 27, 2024

Changes in this version

+ const RequestKey

+ func Next(c *Context)

type Context

+ func (c *Context) BindBodyWithJSON(obj any) error

+ func (c *Context) BindBodyWithXML(obj any) error

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

v1.0.14

Mar 19, 2024

Changes in this version

+ var AnywhereCIDRs = []string

+ func StaticFSFunc(r IRoutes, relativePath string, hfsc func(c *Context) http.FileSystem, ...)

+ func StaticFSFuncFile(r IRoutes, relativePath string, hfsc func(c *Context) http.FileSystem, ...)

type Context

+ func (c *Context) AbortWithStatusText(code int, format string, values ...any)

+ func (c *Context) IsSecure() bool

type Engine

+ SSLProxyHeaders map[string]string

type HandlerFunc

+ func ServeFSFuncFileHandler(hfsc func(c *Context) http.FileSystem, filePath string) HandlerFunc

+ func ServeFSFuncHandler(prefix string, hfsc func(c *Context) http.FileSystem, filePath string) HandlerFunc

v1.0.13

Feb 19, 2024

Changes in this version

+ func StaticFSC(r IRoutes, relativePath string, hfsc func(c *Context) http.FileSystem, ...)

type CacheControlSetter

+ func (ccs *CacheControlSetter) Handle(c *Context)

+ func (ccs *CacheControlSetter) Handler() HandlerFunc

type Context

+ func (c *Context) CopyUploadedFile(file *multipart.FileHeader, dst io.Writer) error

+ func (c *Context) ReadUploadedFile(file *multipart.FileHeader) ([]byte, error)

type HandlerFunc

+ func ServeContentHandler(data []byte, modtime time.Time) HandlerFunc

+ func ServeFSCHandler(prefix string, hfsc func(c *Context) http.FileSystem, filePath string) HandlerFunc

+ func ServeFSHandler(prefix string, hfs http.FileSystem, filePath string) HandlerFunc

type ResponseWriter

+ func NewHeaderWriter(w ResponseWriter, key, value string) ResponseWriter

+ func NewHeadersWriter(w ResponseWriter, h map[string]string) ResponseWriter

v1.0.12

Jan 31, 2024

Changes in this version

+ func Static(r IRoutes, relativePath, root string, wws ...WriterWrapper)

+ func StaticContent(r IRoutes, relativePath string, data []byte, modtime time.Time, ...)

+ func StaticFS(r IRoutes, relativePath string, hfs http.FileSystem, filePath string, ...)

+ func StaticFSFile(r IRoutes, relativePath string, hfs http.FileSystem, filePath string, ...)

+ func StaticFile(r IRoutes, relativePath, filePath string, wws ...WriterWrapper)

+ type CacheControlSetter struct

+ CacheControl string

+ func NewCacheControlSetter(cacheControls ...string) *CacheControlSetter

+ func (ccs *CacheControlSetter) SetCacheControl(cacheControls ...string)

+ func (ccs *CacheControlSetter) WrapWriter(hrw http.ResponseWriter) http.ResponseWriter

+ func (ccs *CacheControlSetter) WriterWrapper() WriterWrapper

type Context

+ func (c *Context) FormFiles(key string) ([]*multipart.FileHeader, error)

+ func (c *Context) GetPostFormMapArray(key string) (map[string][]string, bool)

+ func (c *Context) GetQueryMapArray(key string) (map[string][]string, bool)

+ func (c *Context) GetStringMapStrings(key string) (smss map[string][]string)

+ func (c *Context) GetStrings(key string) (ss []string)

+ func (c *Context) PostFormMapArray(key string) (dict map[string][]string)

+ func (c *Context) PostForms() map[string][]string

+ func (c *Context) QueryMapArray(key string) (dict map[string][]string)

+ func (c *Context) Querys() map[string][]string

type HandlerFunc

+ func ServeContent(data []byte, modtime time.Time, wws ...WriterWrapper) HandlerFunc

+ func ServeFSFileHandler(hfs http.FileSystem, filePath string, wws ...WriterWrapper) HandlerFunc

+ func ServeFileHandler(filePath string, wws ...WriterWrapper) HandlerFunc

+ func ServerFSHandler(prefix string, hfs http.FileSystem, filePath string, wws ...WriterWrapper) HandlerFunc

type IRoutes

+ BasePath func() string

+ type WriterWrapper func(http.ResponseWriter) http.ResponseWriter

v1.0.11

Nov 6, 2023

v1.0.10

Oct 8, 2023

Changes in this version

+ func Recover(c *Context, r RecoveryFunc)

type Context

+ func (c *Context) SetAttachmentHeader(filename string)

type HandlerFunc

+ func CustomRecovery(r RecoveryFunc) HandlerFunc

+ type RecoveryFunc func(c *Context, err interface{})

v1.0.9

Jul 19, 2023

v1.0.8

Apr 23, 2023

Changes in this version

+ const BindKey

+ const BodyBytesKey

+ const ContextKey

+ const MIMEHTML

+ const MIMEJSON

+ const MIMEMultipartPOSTForm

+ const MIMEPOSTForm

+ const MIMEPlain

+ const MIMEXML

+ const MIMEXML2

+ const PlatformCloudflare

+ const PlatformGoogleAppEngine

+ func CreateTestContext(w http.ResponseWriter) (c *Context, r *Engine)

+ func Dir(root string, browsable ...bool) http.FileSystem

+ func EnableJSONDecoderDisallowUnknownFields()

+ func EnableJSONDecoderUseNumber()

+ func FS(fsys fs.FS, browsable ...bool) http.FileSystem

+ func FixedModTimeFS(hfs http.FileSystem, mt time.Time) http.FileSystem

+ func IsBrokenPipeError(err any) bool

+ func RedirectToSlach(c *Context)

+ func SaveUploadedFile(file *multipart.FileHeader, dst string) error

+ type Context struct

+ Accepted []string

+ Errors []error

+ Locale string

+ Logger log.Logger

+ Params Params

+ Request *http.Request

+ Writer ResponseWriter

+ func CreateTestContextOnly(w http.ResponseWriter, r *Engine) (c *Context)

+ func (c *Context) Abort()

+ func (c *Context) AbortWithError(code int, err error)

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

+ func (c *Context) AbortWithStatusJSON(code int, jsonObj any)

+ func (c *Context) AddError(err error)

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

+ func (c *Context) AsciiJSON(code int, obj any)

+ func (c *Context) Attrs() map[string]any

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

+ func (c *Context) BindBodyWith(obj any, bb binding.BodyBinding) (err error)

+ func (c *Context) BindHeader(obj any) error

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

+ func (c *Context) BindQuery(obj any) error

+ func (c *Context) BindURI(obj any) (err error)

+ func (c *Context) BindWith(obj any, b binding.Binding) (err error)

+ func (c *Context) BindXML(obj any) error

+ func (c *Context) ClientIP() string

+ func (c *Context) ContentType() string

+ func (c *Context) Cookie(name string) (string, error)

+ func (c *Context) Copy() *Context

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

+ func (c *Context) DataFromReader(code int, contentLength int64, contentType string, reader io.Reader, ...)

+ func (c *Context) Deadline() (deadline time.Time, ok bool)

+ func (c *Context) Done() <-chan struct{}

+ func (c *Context) Err() error

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

+ func (c *Context) FileAttachment(filepath, filename string)

+ func (c *Context) FileFromFS(filepath string, fs http.FileSystem)

+ func (c *Context) FormFile(name string) (*multipart.FileHeader, error)

+ func (c *Context) FullPath() string

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

+ func (c *Context) GetBool(key string) (b bool)

+ func (c *Context) GetDuration(key string) (d time.Duration)

+ func (c *Context) GetFloat64(key string) (f64 float64)

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

+ func (c *Context) GetInt(key string) (i int)

+ func (c *Context) GetInt64(key string) (i64 int64)

+ func (c *Context) GetPostForm(key string) (string, bool)

+ func (c *Context) GetPostFormArray(key string) (values []string, ok bool)

+ func (c *Context) GetPostFormMap(key string) (map[string]string, bool)

+ func (c *Context) GetQuery(key string) (string, bool)

+ func (c *Context) GetQueryArray(key string) (values []string, ok bool)

+ func (c *Context) GetQueryMap(key string) (map[string]string, bool)

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

+ func (c *Context) GetString(key string) (s string)

+ func (c *Context) GetStringMap(key string) (sm map[string]any)

+ func (c *Context) GetStringMapString(key string) (sms map[string]string)

+ func (c *Context) GetStringMapStringSlice(key string) (smss map[string][]string)

+ func (c *Context) GetStringSlice(key string) (ss []string)

+ func (c *Context) GetTime(key string) (t time.Time)

+ func (c *Context) GetUint(key string) (ui uint)

+ func (c *Context) GetUint64(key string) (ui64 uint64)

+ func (c *Context) HTML(code int, name string, obj any)

+ func (c *Context) Handler() HandlerFunc

+ func (c *Context) HandlerName() string

+ func (c *Context) HandlerNames() []string

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

+ func (c *Context) IndentedJSON(code int, obj any)

+ func (c *Context) IsAborted() bool

+ func (c *Context) IsWebsocket() bool

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

+ func (c *Context) JSONP(code int, obj any)

+ func (c *Context) MultipartForm() (*multipart.Form, error)

+ func (c *Context) MustBind(obj any) error

+ func (c *Context) MustBindHeader(obj any) error

+ func (c *Context) MustBindJSON(obj any) error

+ func (c *Context) MustBindQuery(obj any) error

+ func (c *Context) MustBindURI(obj any) error

+ func (c *Context) MustBindWith(obj any, b binding.Binding) error

+ func (c *Context) MustBindXML(obj any) error

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

+ func (c *Context) Negotiate(code int, config Negotiate)

+ func (c *Context) NegotiateFormat(offered ...string) string

+ func (c *Context) Next()

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

+ func (c *Context) PostForm(key string, defs ...string) string

+ func (c *Context) PostFormArray(key string) (values []string)

+ func (c *Context) PostFormMap(key string) (dicts map[string]string)

+ func (c *Context) PureJSON(code int, obj any)

+ func (c *Context) Query(key string, defs ...string) string

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

+ func (c *Context) QueryMap(key string) (dicts map[string]string)

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

+ func (c *Context) RemoteIP() string

+ func (c *Context) Render(code int, r render.Render)

+ func (c *Context) SSEvent(name string, message any)

+ func (c *Context) SaveUploadedFile(file *multipart.FileHeader, dst string) error

+ func (c *Context) SecureJSON(code int, obj any)

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

+ func (c *Context) SetAccepted(formats ...string)

+ func (c *Context) SetCookie(name, value string, maxAge int, path, domain string, secure, httpOnly bool)

+ func (c *Context) SetSameSite(samesite http.SameSite)

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

+ func (c *Context) Stream(step func(w io.Writer) bool) bool

+ func (c *Context) String(code int, format string, values ...any)

+ func (c *Context) Value(key any) any

+ func (c *Context) XML(code int, obj any)

+ type Engine struct

+ ContextWithFallback bool

+ HTMLTemplates render.HTMLTemplates

+ HandleMethodNotAllowed bool

+ Logger log.Logger

+ MaxMultipartMemory int64

+ RedirectFixedPath bool

+ RedirectTrailingSlash bool

+ RemoteIPHeaders []string

+ RemoveExtraSlash bool

+ TrustedIPHeader string

+ UnescapePathValues bool

+ UseRawPath bool

+ Validator validate.StructValidator

+ func Default() *Engine

+ func New() *Engine

+ func (engine *Engine) HandleContext(c *Context)

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

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

+ func (engine *Engine) Routes() (routes RoutesInfo)

+ func (engine *Engine) SecureJSONPrefix(prefix string) *Engine

+ func (engine *Engine) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (engine *Engine) SetTrustedProxies(trustedProxies []string) error

+ func (engine *Engine) Use(middleware ...HandlerFunc) IRoutes

+ type H map[string]any

+ func (h H) MarshalXML(e *xml.Encoder, start xml.StartElement) error

+ type HandlerFunc func(*Context)

+ func MustBind(val any) HandlerFunc

+ func Recovery() HandlerFunc

+ func Redirector(url string, codes ...int) HandlerFunc

+ func WrapF(f http.HandlerFunc) HandlerFunc

+ func WrapH(h http.Handler) HandlerFunc

+ type HandlersChain []HandlerFunc

+ func (c HandlersChain) Last() HandlerFunc

+ type IRouter interface

+ Group func(string, ...HandlerFunc) *RouterGroup

+ type IRoutes interface

+ Any func(string, ...HandlerFunc) IRoutes

+ DELETE func(string, ...HandlerFunc) IRoutes

+ GET func(string, ...HandlerFunc) IRoutes

+ HEAD func(string, ...HandlerFunc) IRoutes

+ Handle func(string, string, ...HandlerFunc) IRoutes

+ OPTIONS func(string, ...HandlerFunc) IRoutes

+ PATCH func(string, ...HandlerFunc) IRoutes

+ POST func(string, ...HandlerFunc) IRoutes

+ PUT func(string, ...HandlerFunc) IRoutes

+ Static func(string, string, ...string) IRoutes

+ StaticContent func(relativePath string, data []byte, modtime time.Time, cacheControls ...string) IRoutes

+ StaticFS func(string, string, http.FileSystem, ...string) IRoutes

+ StaticFSFile func(relativePath, filePath string, hfs http.FileSystem, cacheControls ...string) IRoutes

+ StaticFile func(string, string, ...string) IRoutes

+ Use func(...HandlerFunc) IRoutes

+ type Negotiate struct

+ Data any

+ HTMLData any

+ HTMLName string

+ JSONData any

+ Offered []string

+ XMLData any

+ type Param struct

+ Key string

+ Value string

+ type Params []Param

+ func (ps Params) ByName(name string) (va string)

+ func (ps Params) Get(name string) (string, bool)

+ type ResponseWriter interface

+ Pusher func() http.Pusher

+ Size func() int

+ Status func() int

+ WriteHeaderNow func()

+ WriteString func(string) (int, error)

+ Written func() bool

+ type RouteInfo struct

+ Handler string

+ HandlerFunc HandlerFunc

+ Method string

+ Path string

+ type RouterGroup struct

+ Handlers HandlersChain

+ func (group *RouterGroup) Any(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) BasePath() string

+ func (group *RouterGroup) DELETE(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) GET(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) Group(relativePath string, handlers ...HandlerFunc) *RouterGroup

+ func (group *RouterGroup) HEAD(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) Handle(httpMethod, relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) OPTIONS(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) PATCH(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) POST(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) PUT(relativePath string, handlers ...HandlerFunc) IRoutes

+ func (group *RouterGroup) Static(relativePath, root string, cacheControls ...string) IRoutes

+ func (group *RouterGroup) StaticContent(relativePath string, data []byte, modtime time.Time, cacheControls ...string) IRoutes

+ func (group *RouterGroup) StaticFS(relativePath string, localPath string, hfs http.FileSystem, ...) IRoutes

+ func (group *RouterGroup) StaticFSFile(relativePath, filePath string, hfs http.FileSystem, cacheControls ...string) IRoutes

+ func (group *RouterGroup) StaticFile(relativePath, localPath string, cacheControls ...string) IRoutes

+ func (group *RouterGroup) Use(middleware ...HandlerFunc) IRoutes

+ type RoutesInfo []RouteInfo

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