rux

package module

Go to main page

Versions in this module

v1

v1.4.0

Jul 27, 2023

Changes in this version

type Context

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

type Router

+ func (r *Router) Err() error

v1.3.4

Aug 12, 2022

v1.3.3

Apr 14, 2022

Changes in this version

type HandlerFunc

+ func WrapH(hh http.Handler) HandlerFunc

+ func WrapHF(hf http.HandlerFunc) HandlerFunc

type Router

+ func (r *Router) QuickMatch(method, path string) (route *Route, ps Params, alm []string)

v1.3.2

Apr 12, 2021

v1.3.1

Dec 11, 2020

v1.3.0

Sep 11, 2020

Changes in this version

+ var CreateAction = "Create"

+ var DeleteAction = "Delete"

+ var EditAction = "Edit"

+ var IndexAction = "Index"

+ var RESTFulActions = map[string][]string

+ var ShowAction = "Show"

+ var StoreAction = "Store"

+ var UpdateAction = "Update"

+ func HandleFallbackRoute(r *Router)

+ func MethodsString() string

type Context

+ func (c *Context) AutoBind(obj interface{}) error

+ func (c *Context) BindForm(obj interface{}) error

+ func (c *Context) BindJSON(obj interface{}) error

+ func (c *Context) BindXML(obj interface{}) error

+ func (c *Context) MustBind(obj interface{}, binder binding.Binder)

+ func (c *Context) MustRender(status int, obj interface{}, renderer render.Renderer)

+ func (c *Context) Respond(status int, obj interface{}, renderer render.Renderer)

+ func (c *Context) ShouldBind(obj interface{}, binder binding.Binder) error

+ func (c *Context) ShouldRender(status int, obj interface{}, renderer render.Renderer) error

type HandlerFunc

+ func HTTPHandler(gh http.Handler) HandlerFunc

+ func HTTPHandlerFunc(hf http.HandlerFunc) HandlerFunc

type Route

+ func (r *Route) Handlers() HandlersChain

+ func (r *Route) ToURL(buildArgs ...interface{}) *url.URL

v1.2.10

Sep 10, 2020

v1.2.9

Aug 8, 2020

Changes in this version

type Context

+ func (c *Context) DelCookie(names ...string)

v1.2.8

Jul 25, 2020

Changes in this version

+ func CachingWithNum(num uint16) func(*Router)

v1.2.7

Jul 5, 2020

Changes in this version

type Context

+ func (c *Context) Length() int

v1.2.6

Jun 23, 2020

Changes in this version

type RouteInfo

+ HandlerNum int

type Router

+ func (r *Router) NamedRoutes() map[string]*Route

v1.2.5

Jan 2, 2020

Changes in this version

type Router

+ func (r *Router) BuildURL(name string, buildArgs ...interface{}) *url.URL

v1.2.4

Aug 30, 2019

Changes in this version

type Context

+ func (c *Context) FormParams(excepts ...[]string) (url.Values, error)

type Router

+ func (r *Router) Resource(basePath string, controller interface{}, middles ...HandlerFunc)

v1.2.3

Aug 7, 2019

Changes in this version

+ type CachedRoutes struct

+ func NewCachedRoutes(size int) *CachedRoutes

+ func (c *CachedRoutes) Delete(k string)

+ func (c *CachedRoutes) Get(k string) *Route

+ func (c *CachedRoutes) Has(k string) (*Route, bool)

+ func (c *CachedRoutes) Items() map[string]*Route

+ func (c *CachedRoutes) Len() int

+ func (c *CachedRoutes) Set(k string, v *Route) bool

v1.2.2

Aug 5, 2019

Changes in this version

type Context

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

v1.2.1

Aug 3, 2019

Changes in this version

type Context

+ func (c *Context) JSONP(status int, callback string, i interface{})

+ func (c *Context) XML(status int, i interface{}, indents ...string)

type Route

+ func NamedRoute(name, path string, handler HandlerFunc, methods ...string) *Route

type Router

+ func (r *Router) AddNamed(name, path string, handler HandlerFunc, methods ...string) *Route

+ func (r *Router) Handlers() HandlersChain

v1.2.0

Aug 1, 2019

Changes in this version

+ const CTXCurrentRoutePath

type Context

+ func (c *Context) IsGet() bool

type MatchResult

+ Path string

type Route

+ func (r *Route) MethodString(char string) string

+ func (r *Route) Methods() []string

type RouteInfo

+ Methods []string

+ Name string

v1.1.5

Aug 1, 2019

Changes in this version

+ const CTXCurrentRouteName

+ type Binder interface

+ Bind func(i interface{}, c *Context) error

+ type BuildRequestURL struct

+ func NewBuildRequestURL() *BuildRequestURL

+ func (b *BuildRequestURL) Build() *url.URL

+ func (b *BuildRequestURL) Host(host string) *BuildRequestURL

+ func (b *BuildRequestURL) Params(params ...string) *BuildRequestURL

+ func (b *BuildRequestURL) Path(path string) *BuildRequestURL

+ func (b *BuildRequestURL) Queries(queries url.Values) *BuildRequestURL

+ func (b *BuildRequestURL) Scheme(scheme string) *BuildRequestURL

+ func (b *BuildRequestURL) User(username, password string) *BuildRequestURL

type Context

+ func (c *Context) Back(optionalCode ...int)

+ func (c *Context) Bind(i interface{}) error

+ func (c *Context) IsPost() bool

+ func (c *Context) Render(name string, data interface{}) error

+ func (c *Context) Validate(i interface{}) error

type MatchResult

+ Name string

+ type Renderer interface

+ Render func(io.Writer, string, interface{}, *Context) error

type Route

+ func NewNamedRoute(name, method, path string, handler HandlerFunc, middleware ...HandlerFunc) *Route

type Router

+ Binder Binder

+ Renderer Renderer

+ Validator Validator

+ func (r *Router) AnyMethodsIteration(iteration func(string) *Route)

+ func (r *Router) BuildRequestURL(name string, buildRequestURL *BuildRequestURL) *url.URL

+ type Validator interface

+ Validate func(i interface{}) error

v1.1.4

Jul 28, 2019

Changes in this version

type Context

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

+ func (c *Context) SetStatusCode(status int)

v1.1.3

Mar 10, 2019

Changes in this version

type Context

+ func (c *Context) FirstError() error

+ type ControllerFace interface

+ AddRoutes func(g *Router)

v1.1.2

Dec 12, 2018

Changes in this version

+ const CTXRecoverResult

type Context

+ func (c *Context) FastSetCookie(name, value string, maxAge int)

type Router

+ Name string

+ OnError HandlerFunc

+ OnPanic HandlerFunc

v1.1.1

Dec 9, 2018

v1.1.0

Dec 9, 2018

Changes in this version

+ const IrregularType

+ const RegularType

+ const StaticType

+ const StringMethods

type Context

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

+ func (c *Context) ContentType() string

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

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

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

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

+ func (c *Context) StatusCode() int

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

+ func (c *Context) WriteBytes(bt []byte)

type HandlerFunc

+ func WrapHTTPHandler(gh http.Handler) HandlerFunc

+ func WrapHTTPHandlerFunc(gh http.HandlerFunc) HandlerFunc

type Route

+ func NewRoute(method, path string, handler HandlerFunc, middleware ...HandlerFunc) *Route

+ func (r *Route) AttachTo(router *Router)

+ func (r *Route) Info() RouteInfo

+ func (r *Route) Method() string

+ func (r *Route) Name() string

+ func (r *Route) NamedTo(name string, router *Router)

+ func (r *Route) Path() string

+ func (r *Route) SetName(name string) *Route

+ type RouteInfo struct

+ HandlerName string

+ Method string

+ Path string

type Router

+ func (r *Router) AddRoute(route *Route) *Route

+ func (r *Router) GetRoute(name string) *Route

+ func (r *Router) HandleContext(c *Context)

+ func (r *Router) IterateRoutes(fn func(route *Route))

+ func (r *Router) Routes() (rs []RouteInfo)

+ func (r *Router) WrapHTTPHandlers(preHandlers ...func(h http.Handler) http.Handler) http.Handler

v1.0.2

Sep 10, 2018

Changes in this version

+ func AnyMethods() []string

v1.0.1

Sep 4, 2018

Changes in this version

type Context

+ func (c *Context) Data() map[string]interface{}

type Router

+ func (r *Router) StaticFS(prefixUrl string, fs http.FileSystem)

v1.0.0

Aug 30, 2018

Changes in this version

+ const AllMethods

+ const CONNECT

+ const CTXAllowedMethods

+ const ContentBinary

+ const ContentDisposition

+ const ContentType

+ const DELETE

+ const Found

+ const GET

+ const HEAD

+ const NotAllowed

+ const NotFound

+ const OPTIONS

+ const PATCH

+ const POST

+ const PUT

+ const TRACE

+ func Debug(val bool)

+ func EnableCaching(r *Router)

+ func GetGlobalVars() map[string]string

+ func HandleMethodNotAllowed(r *Router)

+ func InterceptAll(path string) func(*Router)

+ func IsDebug() bool

+ func MaxNumCaches(num uint16) func(*Router)

+ func SetGlobalVar(name, regex string)

+ func StrictLastSlash(r *Router)

+ func UseEncodedPath(r *Router)

+ type Context struct

+ Errors []*error

+ Params Params

+ Req *http.Request

+ Resp http.ResponseWriter

+ func (c *Context) Abort()

+ func (c *Context) AbortThen() *Context

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

+ func (c *Context) Attachment(srcFile, outName string)

+ func (c *Context) Binary(status int, in io.ReadSeeker, outName string, inline bool) error

+ func (c *Context) ClientIP() string

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

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

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

+ func (c *Context) Err() error

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

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

+ func (c *Context) FileContent(file string, names ...string)

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

+ func (c *Context) Get(key string) (v interface{}, ok bool)

+ func (c *Context) HTML(status int, data []byte) (err error)

+ func (c *Context) HTTPError(msg string, status int)

+ func (c *Context) Handler() HandlerFunc

+ func (c *Context) HandlerName() string

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

+ func (c *Context) Init(res http.ResponseWriter, req *http.Request)

+ func (c *Context) Inline(srcFile, outName string)

+ func (c *Context) IsAborted() bool

+ func (c *Context) IsAjax() bool

+ func (c *Context) IsMethod(method string) bool

+ func (c *Context) IsTLS() bool

+ func (c *Context) IsWebSocket() bool

+ func (c *Context) JSON(status int, v interface{}) (err error)

+ func (c *Context) JSONBytes(status int, bs []byte) (err error)

+ func (c *Context) MustGet(key string) interface{}

+ func (c *Context) Next()

+ func (c *Context) NoContent() error

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

+ func (c *Context) ParseMultipartForm(maxMemory ...int) error

+ func (c *Context) Post(key string, defVal ...string) string

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

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

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

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

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

+ func (c *Context) QueryValues() url.Values

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

+ func (c *Context) Redirect(path string, optionalCode ...int)

+ func (c *Context) ReqCtxValue(key interface{}) interface{}

+ func (c *Context) Reset()

+ func (c *Context) Router() *Router

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

+ func (c *Context) Set(key string, val interface{})

+ func (c *Context) SetHandlers(handlers HandlersChain)

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

+ func (c *Context) SetStatus(status int)

+ func (c *Context) Text(status int, str string) (err error)

+ func (c *Context) URL() *url.URL

+ func (c *Context) UploadFile(name string, saveAs string) error

+ func (c *Context) Value(key interface{}) interface{}

+ func (c *Context) Values() map[string]interface{}

+ func (c *Context) WithReqCtxValue(key, val interface{})

+ func (c *Context) Write(bt []byte) (n int, err error)

+ func (c *Context) WriteString(str string) (n int, err error)

+ type HandlerFunc func(c *Context)

+ func WarpHttpHandler(gh http.Handler) HandlerFunc

+ func WarpHttpHandlerFunc(gh http.HandlerFunc) HandlerFunc

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

+ type HandlersChain []HandlerFunc

+ func (c HandlersChain) Last() HandlerFunc

+ type IController interface

+ AddRoutes func(g *Router)

+ type M map[string]interface

+ type MatchResult struct

+ AllowedMethods []string

+ Handler HandlerFunc

+ Handlers HandlersChain

+ Params Params

+ Status uint8

+ func (mr *MatchResult) IsOK() bool

+ type Params map[string]string

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

+ func (p Params) Int(key string) (val int)

+ func (p Params) String(key string) (val string)

+ type Route struct

+ Opts map[string]interface{}

+ func (r *Route) Handler() HandlerFunc

+ func (r *Route) HandlerName() string

+ func (r *Route) String() string

+ func (r *Route) Use(middleware ...HandlerFunc) *Route

+ type Router struct

+ func New(options ...func(*Router)) *Router

+ func (r *Router) Add(method, path string, handler HandlerFunc, middleware ...HandlerFunc) (route *Route)

+ func (r *Router) Any(path string, handler HandlerFunc, middleware ...HandlerFunc)

+ func (r *Router) CONNECT(path string, handler HandlerFunc, middleware ...HandlerFunc) *Route

+ func (r *Router) Controller(basePath string, controller IController, middleware ...HandlerFunc)

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

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

+ func (r *Router) Group(prefix string, register func(), middleware ...HandlerFunc)

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

+ func (r *Router) Listen(addr ...string) (err error)

+ func (r *Router) ListenTLS(addr, certFile, keyFile string) (err error)

+ func (r *Router) ListenUnix(file string) (err error)

+ func (r *Router) Match(method, path string) (result *MatchResult)

+ func (r *Router) NotAllowed(handlers ...HandlerFunc)

+ func (r *Router) NotFound(handlers ...HandlerFunc)

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

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

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

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

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

+ func (r *Router) StaticDir(prefixUrl string, fileDir string)

+ func (r *Router) StaticFile(path, filePath string)

+ func (r *Router) StaticFiles(prefixUrl string, rootDir string, exts string)

+ func (r *Router) StaticFunc(path string, handler func(c *Context))

+ func (r *Router) String() string

+ func (r *Router) TRACE(path string, handler HandlerFunc, middleware ...HandlerFunc) *Route

+ func (r *Router) Use(handlers ...HandlerFunc)

+ func (r *Router) WithOptions(options ...func(*Router))

+ func (r *Router) WrapHttpHandlers(preHandlers ...func(h http.Handler) http.Handler) http.Handler

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