rock

package module

Go to main page

Versions in this module

v0

v0.4.0

Aug 3, 2026

Changes in this version

type Context

+ File func(filepath string)

+ ShouldBindJSON func(v interface{}) error

+ ShouldBindQuery func(v interface{}) error

type Ctx

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

+ func (c *Ctx) ShouldBindJSON(v interface{}) error

+ func (c *Ctx) ShouldBindQuery(v interface{}) error

v0.3.1

Aug 3, 2026

v0.3.0

Aug 3, 2026

Changes in this version

+ var CommonErrorMessages = map[ErrorCode]string

+ func Debug(args ...interface{})

+ func Debugf(format string, args ...interface{})

+ func Error(args ...interface{})

+ func Errorf(format string, args ...interface{})

+ func Fatal(args ...interface{})

+ func Fatalf(format string, args ...interface{})

+ func GetCaller() (file string, line int, function string)

+ func GetErrorMessage(code ErrorCode) string

+ func GetFileMIMEType(fh *multipart.FileHeader) (string, error)

+ func HandlePanic(c Context, message interface{})

+ func Info(args ...interface{})

+ func Infof(format string, args ...interface{})

+ func SetDebug(enabled bool)

+ func SetDefaultLogger(logger *RockLogger)

+ func ValidateFile(fh *multipart.FileHeader, config *FileUploadConfig) error

+ func ValidateMIMEType(fh *multipart.FileHeader, config *FileUploadConfig) error

+ func Warn(args ...interface{})

+ func Warnf(format string, args ...interface{})

+ func WriteError(c Context, statusCode int, err error)

+ func WriteSuccess(c Context, data interface{})

type App

+ func (app *App) EnableRequestLog(enabled bool)

+ func (app *App) Logger() *RockLogger

+ func (app *App) RunTLS(addr, certFile, keyFile string) error

+ func (app *App) SetDebug(enabled bool)

+ func (app *App) SetLogLevel(level LogLevel)

+ func (app *App) SetLoggerOutput(outputs ...io.Writer)

+ func (app *App) SetTrustProxy(enabled bool)

+ type AppError struct

+ Code ErrorCode

+ Detail string

+ Message string

+ func NewAppError(code ErrorCode, message string) *AppError

+ func NewAppErrorWithDetail(code ErrorCode, message, detail string) *AppError

+ func NewError(code ErrorCode, format string, args ...interface{}) *AppError

+ func (e *AppError) Error() string

type Configuration

+ TrustProxyHeaders bool

type Context

+ App func() *App

+ Application func() *App

+ GetMethod func() string

+ GetPath func() string

+ GetViewData func() map[string]interface{}

+ LogDebug func(msg string, args ...interface{})

+ LogError func(msg string, args ...interface{})

+ LogInfo func(msg string, args ...interface{})

+ LogWarn func(msg string, args ...interface{})

+ Logger func() *RockLogger

+ MustQueryString func(name string, d string) string

+ ResetRequest func(r *http.Request)

+ SaveMultipleFiles func(name string, config *FileUploadConfig) ([]*FileInfo, error)

+ SaveSingleFile func(name string, config *FileUploadConfig) (*FileInfo, error)

+ ShouldBind func(v interface{}, args ...interface{}) (err error)

+ UploadMultipleImages func(name string) ([]*FileInfo, error)

+ UploadSingleDocument func(name string) (*FileInfo, error)

+ UploadSingleImage func(name string) (*FileInfo, error)

+ Values func() *Store

+ ViewData func(key string, value interface{})

type Ctx

+ func (c *Ctx) App() *App

+ func (c *Ctx) Application() *App

+ func (c *Ctx) GetMethod() string

+ func (c *Ctx) GetPath() string

+ func (c *Ctx) LogDebug(msg string, args ...interface{})

+ func (c *Ctx) LogError(msg string, args ...interface{})

+ func (c *Ctx) LogInfo(msg string, args ...interface{})

+ func (c *Ctx) LogWarn(msg string, args ...interface{})

+ func (c *Ctx) Logger() *RockLogger

+ func (c *Ctx) MustQueryString(name string, d string) string

+ func (c *Ctx) ResetRequest(r *http.Request)

+ func (c *Ctx) SaveMultipleFiles(name string, config *FileUploadConfig) ([]*FileInfo, error)

+ func (c *Ctx) SaveSingleFile(name string, config *FileUploadConfig) (*FileInfo, error)

+ func (c *Ctx) ShouldBind(v interface{}, args ...interface{}) (err error)

+ func (c *Ctx) UploadMultipleImages(name string) ([]*FileInfo, error)

+ func (c *Ctx) UploadSingleDocument(name string) (*FileInfo, error)

+ func (c *Ctx) UploadSingleImage(name string) (*FileInfo, error)

+ func (ctx *Ctx) GetViewData() map[string]interface{}

+ func (ctx *Ctx) Values() *Store

+ func (ctx *Ctx) ViewData(key string, value interface{})

+ type ErrorCode int

+ const ErrBadGateway

+ const ErrBadRequest

+ const ErrForbidden

+ const ErrInternalServer

+ const ErrMethodNotAllow

+ const ErrNotFound

+ const ErrUnauthorized

+ const ErrUnprocessable

+ type ErrorResponse struct

+ Error HTTPError

+ Success bool

+ type FileInfo struct

+ Extension string

+ Filename string

+ Header *multipart.FileHeader

+ MIMEType string

+ SavedPath string

+ Size int64

+ URL string

+ UploadTime time.Time

+ func SaveMultipleFiles(c Context, name string, config *FileUploadConfig) ([]*FileInfo, error)

+ func SaveSingleFile(c Context, name string, config *FileUploadConfig) (*FileInfo, error)

+ func UploadMultipleImages(c Context, name string) ([]*FileInfo, error)

+ func UploadSingleDocument(c Context, name string) (*FileInfo, error)

+ func UploadSingleImage(c Context, name string) (*FileInfo, error)

+ type FileUploadConfig struct

+ AllowedExtensions []string

+ AllowedMimeTypes []string

+ FilenamePrefix string

+ GenerateUniqueName bool

+ MaxFileSize int64

+ MaxTotalSize int64

+ SaveDir string

+ func DefaultFileUploadConfig() *FileUploadConfig

+ type HTTPError struct

+ Code int

+ Detail string

+ Message string

type HandlerFunc

+ func GetUploadHandler(config *FileUploadConfig) HandlerFunc

+ type LogLevel int

+ const LevelDebug

+ const LevelError

+ const LevelFatal

+ const LevelInfo

+ const LevelWarn

+ func (l LogLevel) String() string

type Logger

+ AddOutput func(output io.Writer)

+ Debug func(args ...interface{})

+ Debugf func(format string, args ...interface{})

+ Error func(args ...interface{})

+ Errorf func(format string, args ...interface{})

+ Fatal func(args ...interface{})

+ Fatalf func(format string, args ...interface{})

+ GetLevel func() LogLevel

+ Info func(args ...interface{})

+ Infof func(format string, args ...interface{})

+ RequestLog func(method, path, ip, userAgent string, statusCode int, latency time.Duration)

+ SetLevel func(level LogLevel)

+ Warn func(args ...interface{})

+ Warnf func(format string, args ...interface{})

+ type LoggerWithCaller struct

+ func WrapLoggerWithCaller(logger Logger) *LoggerWithCaller

+ func (lc *LoggerWithCaller) AddOutput(output io.Writer)

+ func (lc *LoggerWithCaller) Debug(args ...interface{})

+ func (lc *LoggerWithCaller) Debugf(format string, args ...interface{})

+ func (lc *LoggerWithCaller) Error(args ...interface{})

+ func (lc *LoggerWithCaller) Errorf(format string, args ...interface{})

+ func (lc *LoggerWithCaller) Fatal(args ...interface{})

+ func (lc *LoggerWithCaller) Fatalf(format string, args ...interface{})

+ func (lc *LoggerWithCaller) GetLevel() LogLevel

+ func (lc *LoggerWithCaller) Info(args ...interface{})

+ func (lc *LoggerWithCaller) Infof(format string, args ...interface{})

+ func (lc *LoggerWithCaller) RequestLog(method, path, ip, userAgent string, statusCode int, latency time.Duration)

+ func (lc *LoggerWithCaller) SetLevel(level LogLevel)

+ func (lc *LoggerWithCaller) Warn(args ...interface{})

+ func (lc *LoggerWithCaller) Warnf(format string, args ...interface{})

+ type RockLogger struct

+ func GetDefaultLogger() *RockLogger

+ func NewLogger() *RockLogger

+ func NewLoggerWithConfig(level LogLevel, outputs []io.Writer, enableRequestLog bool) *RockLogger

+ func (rl *RockLogger) AddOutput(output io.Writer)

+ func (rl *RockLogger) Debug(args ...interface{})

+ func (rl *RockLogger) Debugf(format string, args ...interface{})

+ func (rl *RockLogger) EnableRequestLog(enabled bool)

+ func (rl *RockLogger) Error(args ...interface{})

+ func (rl *RockLogger) Errorf(format string, args ...interface{})

+ func (rl *RockLogger) Fatal(args ...interface{})

+ func (rl *RockLogger) Fatalf(format string, args ...interface{})

+ func (rl *RockLogger) GetLevel() LogLevel

+ func (rl *RockLogger) Info(args ...interface{})

+ func (rl *RockLogger) Infof(format string, args ...interface{})

+ func (rl *RockLogger) RequestLog(method, path, ip, userAgent string, statusCode int, latency time.Duration)

+ func (rl *RockLogger) SetCallerInfo(enabled bool)

+ func (rl *RockLogger) SetLevel(level LogLevel)

+ func (rl *RockLogger) SetOutputs(outputs ...io.Writer)

+ func (rl *RockLogger) Warn(args ...interface{})

+ func (rl *RockLogger) Warnf(format string, args ...interface{})

type RouterGroup

+ func (group *RouterGroup) ClearMiddleware()

+ func (group *RouterGroup) Delete(pattern string, handler HandlerFunc)

+ func (group *RouterGroup) Options(pattern string, handler HandlerFunc)

+ func (group *RouterGroup) Patch(pattern string, handler HandlerFunc)

+ func (group *RouterGroup) Put(pattern string, handler HandlerFunc)

+ func (group *RouterGroup) RemoveMiddleware(index int)

+ func (group *RouterGroup) UseFunc(middlewares ...func(Context))

+ func (group *RouterGroup) UseWithPriority(priority int, middleware HandlerFunc)

type Store

+ func NewStore() *Store

+ type ValidationError struct

+ Field string

+ Message string

+ Value string

+ func (e *ValidationError) Error() string

v0.2.0

May 25, 2022

Changes in this version

+ func EnsureTemplateName(s string, v ViewEngine) string

type App

+ func (app *App) ConfigurationReadOnly() *Configuration

+ func (app *App) GetView() View

+ func (app *App) RegisterView(viewEngine ViewEngine)

+ func (app *App) View(writer io.Writer, filename string, bindingData interface{}) error

+ type BlockEngine struct

+ type Configuration struct

+ FallbackViewContextKey string

+ ViewDataContextKey string

+ ViewEngineContextKey string

+ ViewLayoutContextKey string

+ func DefaultConfiguration() Configuration

+ func (c *Configuration) GetViewDataContextKey() string

+ func (c *Configuration) GetViewEngineContextKey() string

type Context

+ Fail func(code int, err string)

+ GetView func() View

+ Query func(key string) string

+ QueryInt func(key string) int

+ SetHeader func(key string, value string)

+ StatusCode func() int

+ ViewEngine func(engine ViewEngine)

+ Write func(rawBody []byte) (int, error)

+ Writer func() http.ResponseWriter

type Ctx

+ Method string

+ Path string

+ func (c *Ctx) Fail(code int, err string)

+ func (c *Ctx) GetView() View

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

+ func (c *Ctx) QueryInt(key string) int

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

+ func (c *Ctx) StatusCode() int

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

+ func (ctx *Ctx) ViewEngine(engine ViewEngine)

+ func (ctx *Ctx) Write(rawBody []byte) (int, error)

+ type Engine = ViewEngine

+ type Entry struct

+ Key string

+ ValueRaw interface{}

+ func (e Entry) Value() interface{}

+ type H Map

type HandlerFunc

+ func Recovery() HandlerFunc

type HandlersChain

+ func (c HandlersChain) Last() HandlerFunc

+ type Map map[string]interface

+ type MiddlewareFunc = HandlerFunc

+ type PreMiddlewareFunc = HandlerFunc

type Router

+ func NewRouter(opts ...trie.Options) *Router

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

+ type RouterGroup struct

+ func (group *RouterGroup) Get(pattern string, handler HandlerFunc)

+ func (group *RouterGroup) Group(prefix string) *RouterGroup

+ func (group *RouterGroup) NoMethod(handler HandlerFunc)

+ func (group *RouterGroup) NoRoute(handler HandlerFunc)

+ func (group *RouterGroup) Post(pattern string, handler HandlerFunc)

+ func (group *RouterGroup) RegisterView(viewEngine ViewEngine)

+ func (group *RouterGroup) SetRender(render ViewEngine)

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

+ func (group *RouterGroup) Use(middlewares ...HandlerFunc)

+ type Store []Entry

+ func (r *Store) Get(key string) interface{}

+ func (r *Store) GetDefault(key string, def interface{}) interface{}

+ func (r *Store) GetEntry(key string) (Entry, bool)

+ func (r *Store) Save(key string, value interface{}, immutable bool) (Entry, bool)

+ func (r *Store) Set(key string, value interface{}) (Entry, bool)

+ type ValueSetter interface

+ Set func(key string, newValue interface{}) (Entry, bool)

+ type View struct

+ Engine ViewEngine

+ func (v *View) ExecuteWriter(w io.Writer, filename string, bindingData interface{}) error

+ func (v *View) Register(e Engine)

+ func (v *View) Registered() bool

+ type ViewEngine interface

+ ExecuteWriter func(writer io.Writer, filename string, bindingData interface{}) error

+ Ext func() string

+ GetViewDir func() string

+ Name func() string

+ SetViewDir func(viewDir string)

v0.1.0

Nov 28, 2019

Changes in this version

+ const AcceptEncoding

+ const AcceptedLanguage

+ const Allow

+ const ApplicationForm

+ const ApplicationJSON

+ const ApplicationJSONCharsetUTF8

+ const ApplicationJavaScript

+ const ApplicationJavaScriptCharsetUTF8

+ const ApplicationMsgpack

+ const ApplicationProtobuf

+ const ApplicationXML

+ const ApplicationXMLCharsetUTF8

+ const Authorization

+ const CONNECT

+ const CharsetUTF8

+ const ContentDisposition

+ const ContentEncoding

+ const ContentLength

+ const ContentType

+ const DELETE

+ const GET

+ const Gzip

+ const HEAD

+ const Location

+ const MultipartForm

+ const OPTIONS

+ const OctetStream

+ const Origin

+ const PATCH

+ const POST

+ const PUT

+ const TRACE

+ const TextHTML

+ const TextHTMLCharsetUTF8

+ const TextPlain

+ const TextPlainCharsetUTF8

+ const Upgrade

+ const Vary

+ const WWWAuthenticate

+ const XForwardedFor

+ const XRealIP

+ var DebugPrintRouteFunc func(httpMethod, absolutePath, handlerName string, nuHandlers int)

+ var DefaultWriter io.Writer = os.Stdout

+ var NativeChainHandler = http.HandlerFunc(func(w http.ResponseWriter, r *http.Request) { ... })

+ func GetPool() *pool.BufferPool

+ func IsDebugging() bool

+ func Stack() []byte

+ type App struct

+ func Default() *App

+ func New() *App

+ func (app *App) Mux() *chi.Mux

+ func (app *App) NewRouter(path string) *Router

+ func (app *App) Run(addr string)

+ func (app *App) ServeHTTP(w http.ResponseWriter, req *http.Request)

+ func (l *App) BuiltInFormDecoder() *form.Decoder

+ func (l *App) RegisterContext(fn ContextFunc)

+ func (l *App) RegisterCustomHandler(customType interface{}, fn CustomHandlerFunc)

+ func (r *App) GetHTMLRender() HTMLRender

+ func (r *App) HTMLRender(render HTMLRender)

+ type Context interface

+ Abort func()

+ AbortWithStatus func(code int)

+ AbortWithStatusJSON func(code int, jsonObj interface{})

+ AcceptedLanguages func(lowercase bool) []string

+ Attachment func(r io.Reader, filename string) (err error)

+ BaseContext func() *Ctx

+ ClientIP func() (clientIP string)

+ Data func() M

+ Decode func(v interface{}, args ...interface{}) (err error)

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

+ Get func(key string) (interface{}, bool)

+ GetQuery func(name string) (string, bool)

+ HTML func(string, ...int)

+ HTMLRender func(HTMLRender)

+ Inline func(r io.Reader, filename string) (err error)

+ JSON func(int, interface{}) error

+ JSONBytes func(int, []byte) error

+ JSONP func(int, interface{}, string) error

+ MustParamInt func(name string, d int) int

+ MustPostInt func(key string, d int) int

+ MustPostString func(key string, d string) string

+ MustQueryInt func(name string, d int) int

+ Next func()

+ Param func(name string) string

+ ParseForm func() error

+ ParseMultipartForm func(maxMemory int64) error

+ QueryParams func() url.Values

+ Redirect func(url string)

+ Render func(code int, r Render)

+ Request func() *http.Request

+ RequestStart func(w http.ResponseWriter, r *http.Request)

+ Response func() *Response

+ Set func(key string, value interface{})

+ SetData func(M)

+ SetHandlers func([]HandlerFunc)

+ Status func(code int)

+ Stream func(step func(w io.Writer) bool)

+ String func(int, string, ...interface{})

+ Text func(int, string) error

+ TextBytes func(int, []byte) error

+ XML func(int, interface{}) error

+ XMLBytes func(int, []byte) error

+ func GetContext(w http.ResponseWriter) Context

+ type ContextFunc func(l *App) Context

+ type Ctx struct

+ func NewContext(l *App) *Ctx

+ func (c *Ctx) Abort()

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

+ func (c *Ctx) AbortWithStatusJSON(code int, jsonObj interface{})

+ func (c *Ctx) AcceptedLanguages(lowercase bool) []string

+ func (c *Ctx) Attachment(r io.Reader, filename string) (err error)

+ func (c *Ctx) BaseContext() *Ctx

+ func (c *Ctx) ClientIP() (clientIP string)

+ func (c *Ctx) Data() M

+ func (c *Ctx) Decode(v interface{}, args ...interface{}) (err error)

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

+ func (c *Ctx) Get(key string) (value interface{}, exists bool)

+ func (c *Ctx) GetQuery(name string) (string, bool)

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

+ func (c *Ctx) HTMLRender(render HTMLRender)

+ func (c *Ctx) Inline(r io.Reader, filename string) (err error)

+ func (c *Ctx) JSON(code int, i interface{}) (err error)

+ func (c *Ctx) JSONBytes(code int, b []byte) (err error)

+ func (c *Ctx) JSONP(code int, i interface{}, callback string) (err error)

+ func (c *Ctx) MustParamInt(name string, d int) int

+ func (c *Ctx) MustPostInt(key string, d int) int

+ func (c *Ctx) MustPostString(key, d string) string

+ func (c *Ctx) MustQueryInt(name string, d int) int

+ func (c *Ctx) Next()

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

+ func (c *Ctx) ParseForm() error

+ func (c *Ctx) ParseMultipartForm(maxMemory int64) error

+ func (c *Ctx) QueryParams() url.Values

+ func (c *Ctx) Redirect(url string)

+ func (c *Ctx) Render(statusCode int, r Render)

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

+ func (c *Ctx) RequestStart(w http.ResponseWriter, r *http.Request)

+ func (c *Ctx) Response() *Response

+ func (c *Ctx) Set(key string, value interface{})

+ func (c *Ctx) SetData(data M)

+ func (c *Ctx) SetHandlers(handlers []HandlerFunc)

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

+ func (c *Ctx) String(status int, format string, val ...interface{})

+ func (c *Ctx) Text(code int, s string) error

+ func (c *Ctx) TextBytes(code int, b []byte) (err error)

+ func (c *Ctx) XML(code int, i interface{}) error

+ func (c *Ctx) XMLBytes(code int, b []byte) (err error)

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

+ type CustomHandlerFunc func(Context, Handler)

+ type HTMLRender interface

+ GetViewDir func() string

+ Instance func(string, interface{}) Render

+ SetViewDir func(string)

+ type Handler interface

+ func LastHandler(c []Handler) Handler

+ type HandlerFunc func(Context)

+ func Logger() HandlerFunc

+ type HandlersChain []HandlerFunc

+ type M map[string]interface

+ type Render interface

+ Render func(w http.ResponseWriter, statusCode int)

+ type Response struct

+ func (r *Response) CloseNotify() <-chan bool

+ func (r *Response) Committed() bool

+ func (r *Response) Flush()

+ func (r *Response) Header() http.Header

+ func (r *Response) Hijack() (net.Conn, *bufio.ReadWriter, error)

+ func (r *Response) SetWriter(w http.ResponseWriter)

+ func (r *Response) Size() int64

+ func (r *Response) Status() int

+ func (r *Response) Write(b []byte) (n int, err error)

+ func (r *Response) WriteHeader(code int)

+ func (r *Response) WriteString(s string) (n int, err error)

+ func (r *Response) Writer() http.ResponseWriter

+ func (w *Response) WriteHeaderNow()

+ func (w *Response) Written() bool

+ type ResponseWriter interface

+ Before func(func(ResponseWriter))

+ GetBefores func() int

+ Pusher func() http.Pusher

+ Size func() int

+ Status func() int

+ WriteHeaderNow func()

+ WriteString func(string) (int, error)

+ Written func() bool

+ type Router struct

+ func (r *Router) DELETE(path string, handlers ...Handler)

+ func (r *Router) GET(path string, handlers ...Handler)

+ func (r *Router) Group(path string, handlers ...Handler) *Router

+ func (r *Router) HEAD(path string, handlers ...Handler)

+ func (r *Router) HTTPHandlerFunc(h http.HandlerFunc) HandlerFunc

+ func (r *Router) Handle(method, path string, handlers []Handler)

+ func (r *Router) Mount(prefix string, handler http.Handler)

+ func (r *Router) OPTIONS(path string, handlers ...Handler)

+ func (r *Router) PATCH(path string, handlers ...Handler)

+ func (r *Router) POST(path string, handlers ...Handler)

+ func (r *Router) PUT(path string, handlers ...Handler)

+ func (r *Router) RouteNotFound(h HandlerFunc)

+ func (r *Router) Static(path string, root http.FileSystem, handlers ...HandlerFunc)

+ func (r *Router) Use(middlewares ...Handler)

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