gin

package

Go to main page

Versions in this module

v1

v1.13.7

Sep 14, 2023

v1.13.6

Aug 18, 2023

v1.13.5

Jul 14, 2023

v1.13.4

Jul 14, 2023

v1.13.3

Jul 14, 2023

v1.13.2

Jul 13, 2023

v1.13.1

Jul 12, 2023

v1.13.0

Jul 6, 2023

v1.12.6

May 25, 2023

v1.12.5

Apr 24, 2023

v1.12.4

Apr 4, 2023

v1.12.3

Mar 31, 2023

v1.12.2

Mar 31, 2023

v1.12.1

Mar 31, 2023

v1.12.0

Mar 22, 2023

Changes in this version

type IRoutes

+ Match func([]string, string, ...HandlerFunc) IRoutes

type RouterGroup

+ func (group *RouterGroup) Match(methods []string, relativePath string, handlers ...HandlerFunc) IRoutes

v1.11.1

Mar 1, 2023

v1.11.0

Mar 1, 2023

v1.10.2

Feb 3, 2023

v1.10.1

Feb 2, 2023

v1.10.0

Feb 2, 2023

Changes in this version

+ var BindErrorHandler func(c *Context, err error)

type Context

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

type ResponseWriter

+ Data func() []byte

v1.9.0

Feb 2, 2023

Changes in this version

+ const AuthUserKey

+ const ContextKey

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

+ type Accounts map[string]string

+ type Context struct

+ Accepted []string

+ Keys map[string]any

+ Params Params

+ Request *http.Request

+ Writer ResponseWriter

+ func (c *Context) Abort()

+ func (c *Context) AbortWithError(err *errx.Error)

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

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

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

+ 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) Deadline() (deadline time.Time, ok bool)

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

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

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

+ func (c *Context) Err() error

+ func (c *Context) Error(err *errx.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) 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) MultipartForm() (*multipart.Form, error)

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

+ func (c *Context) Next()

+ func (c *Context) OK(obj ...any)

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

+ func (c *Context) PostForm(key string) (value string)

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

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

+ func (c *Context) Query(key string) (value 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) SaveUploadedFile(file *multipart.FileHeader, dst string) error

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

+ 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) String(code int, format string, values ...any)

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

+ type Engine struct

+ ContextWithFallback bool

+ ForwardedByClientIP bool

+ HandleMethodNotAllowed bool

+ MaxMultipartMemory int64

+ RedirectFixedPath bool

+ RedirectTrailingSlash bool

+ RemoteIPHeaders []string

+ RemoveExtraSlash bool

+ TrustedPlatform string

+ UnescapePathValues bool

+ UseRawPath bool

+ func New() *Engine

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

+ func (engine *Engine) Handler() http.Handler

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

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

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

+ 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 HandlerFunc func(*Context)

+ func BasicAuth(accounts Accounts) HandlerFunc

+ func BasicAuthForRealm(accounts Accounts, realm string) 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) IRoutes

+ StaticFS func(string, http.FileSystem) IRoutes

+ StaticFile func(string, string) IRoutes

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

+ Use func(...HandlerFunc) IRoutes

+ 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) IRoutes

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

+ func (group *RouterGroup) StaticFile(relativePath, filepath string) IRoutes

+ func (group *RouterGroup) StaticFileFS(relativePath, filepath string, fs http.FileSystem) 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