Documentation ¶
Overview ¶
Package macaron is a high productive and modular web framework in Go.
Index ¶
- Constants
- Variables
- func Config() *ini.File
- func GenerateETag(fileSize, fileName, modTime string) string
- func GetDefaultListenInfo() (string, int)
- func GetExt(s string) string
- func MatchTest(pattern, url string) bool
- func NewRouteMap() *routeMap
- func ParseTplSet(tplSet string) (tplName string, tplDir string)
- func PrepareCharset(charset string) string
- func SetConfig(source interface{}, others ...interface{}) (_ *ini.File, err error)
- func Version() string
- type BeforeFunc
- type BeforeHandler
- type ComboRouter
- func (cr *ComboRouter) Delete(h ...Handler) *ComboRouter
- func (cr *ComboRouter) Get(h ...Handler) *ComboRouter
- func (cr *ComboRouter) Head(h ...Handler) *ComboRouter
- func (cr *ComboRouter) Name(name string)
- func (cr *ComboRouter) Options(h ...Handler) *ComboRouter
- func (cr *ComboRouter) Patch(h ...Handler) *ComboRouter
- func (cr *ComboRouter) Post(h ...Handler) *ComboRouter
- func (cr *ComboRouter) Put(h ...Handler) *ComboRouter
- type Context
- func (ctx *Context) AllParams() Params
- func (ctx *Context) ChangeStaticPath(oldPath, newPath string)
- func (ctx *Context) GetCookie(name string) string
- func (ctx *Context) GetCookieFloat64(name string) float64
- func (ctx *Context) GetCookieInt(name string) int
- func (ctx *Context) GetCookieInt64(name string) int64
- func (ctx *Context) GetFile(name string) (multipart.File, *multipart.FileHeader, error)
- func (ctx *Context) GetSecureCookie(key string) (string, bool)
- func (ctx *Context) GetSuperSecureCookie(secret, name string) (string, bool)
- func (ctx *Context) HTML(status int, name string, data ...interface{})
- func (ctx *Context) HTMLSet(status int, setName, tplName string, data ...interface{})
- func (ctx *Context) Next()
- func (ctx *Context) Params(name string) string
- func (ctx *Context) ParamsEscape(name string) string
- func (ctx *Context) ParamsFloat64(name string) float64
- func (ctx *Context) ParamsInt(name string) int
- func (ctx *Context) ParamsInt64(name string) int64
- func (ctx *Context) Query(name string) string
- func (ctx *Context) QueryBool(name string) bool
- func (ctx *Context) QueryEscape(name string) string
- func (ctx *Context) QueryFloat64(name string) float64
- func (ctx *Context) QueryInt(name string) int
- func (ctx *Context) QueryInt64(name string) int64
- func (ctx *Context) QueryStrings(name string) []string
- func (ctx *Context) QueryTrim(name string) string
- func (ctx *Context) Redirect(location string, status ...int)
- func (ctx *Context) RemoteAddr() string
- func (ctx *Context) ReplaceAllParams(params Params)
- func (ctx *Context) SaveToFile(name, savePath string) error
- func (ctx *Context) ServeContent(name string, r io.ReadSeeker, params ...interface{})
- func (ctx *Context) ServeFile(file string, names ...string)
- func (ctx *Context) ServeFileContent(file string, names ...string)
- func (ctx *Context) SetCookie(name string, value string, others ...interface{})
- func (ctx *Context) SetParams(name, val string)
- func (ctx *Context) SetSecureCookie(name, value string, others ...interface{})
- func (ctx *Context) SetSuperSecureCookie(secret, name, value string, others ...interface{})
- func (ctx *Context) Written() bool
- type ContextInvoker
- type Delims
- type DummyRender
- func (r *DummyRender) Error(int, ...string)
- func (r *DummyRender) HTML(int, string, interface{}, ...HTMLOptions)
- func (r *DummyRender) HTMLBytes(string, interface{}, ...HTMLOptions) ([]byte, error)
- func (r *DummyRender) HTMLSet(int, string, string, interface{}, ...HTMLOptions)
- func (r *DummyRender) HTMLSetBytes(string, string, interface{}, ...HTMLOptions) ([]byte, error)
- func (r *DummyRender) HTMLSetString(string, string, interface{}, ...HTMLOptions) (string, error)
- func (r *DummyRender) HTMLString(string, interface{}, ...HTMLOptions) (string, error)
- func (r *DummyRender) HasTemplateSet(string) bool
- func (r *DummyRender) JSON(int, interface{})
- func (r *DummyRender) JSONString(interface{}) (string, error)
- func (r *DummyRender) PlainText(int, []byte)
- func (r *DummyRender) RawData(int, []byte)
- func (r *DummyRender) SetResponseWriter(http.ResponseWriter)
- func (r *DummyRender) SetTemplatePath(string, string)
- func (r *DummyRender) Status(int)
- func (r *DummyRender) XML(int, interface{})
- type HTMLOptions
- type Handle
- type Handler
- type Leaf
- type Locale
- type LoggerInvoker
- type Macaron
- func (m *Macaron) Action(handler Handler)
- func (m *Macaron) Before(handler BeforeHandler)
- func (m *Macaron) Handlers(handlers ...Handler)
- func (m *Macaron) Run(args ...interface{})
- func (m *Macaron) ServeHTTP(rw http.ResponseWriter, req *http.Request)
- func (m *Macaron) SetDefaultCookieSecret(secret string)
- func (m *Macaron) SetURLPrefix(prefix string)
- func (m *Macaron) Use(handler Handler)
- type Params
- type Render
- type RenderOptions
- type Request
- type RequestBody
- type ResponseWriter
- type ReturnHandler
- type Route
- type Router
- func (r *Router) Any(pattern string, h ...Handler) *Route
- func (r *Router) Combo(pattern string, h ...Handler) *ComboRouter
- func (r *Router) Delete(pattern string, h ...Handler) *Route
- func (r *Router) Get(pattern string, h ...Handler) (leaf *Route)
- func (r *Router) Group(pattern string, fn func(), h ...Handler)
- func (r *Router) Handle(method string, pattern string, handlers []Handler) *Route
- func (r *Router) Head(pattern string, h ...Handler) *Route
- func (r *Router) InternalServerError(handlers ...Handler)
- func (r *Router) NotFound(handlers ...Handler)
- func (r *Router) Options(pattern string, h ...Handler) *Route
- func (r *Router) Patch(pattern string, h ...Handler) *Route
- func (r *Router) Post(pattern string, h ...Handler) *Route
- func (r *Router) Put(pattern string, h ...Handler) *Route
- func (r *Router) Route(pattern, methods string, h ...Handler) (route *Route)
- func (r *Router) ServeHTTP(rw http.ResponseWriter, req *http.Request)
- func (r *Router) SetAutoHead(v bool)
- func (r *Router) SetHandlerWrapper(f func(Handler) Handler)
- func (r *Router) URLFor(name string, pairs ...string) string
- type StaticOptions
- type TemplateFile
- type TemplateFileSystem
- type TemplateSet
- type TplFile
- type TplFileSystem
- type TplRender
- func (r *TplRender) Error(status int, message ...string)
- func (r *TplRender) HTML(status int, name string, data interface{}, htmlOpt ...HTMLOptions)
- func (r *TplRender) HTMLBytes(name string, data interface{}, htmlOpt ...HTMLOptions) ([]byte, error)
- func (r *TplRender) HTMLSet(status int, setName, tplName string, data interface{}, htmlOpt ...HTMLOptions)
- func (r *TplRender) HTMLSetBytes(setName, tplName string, data interface{}, htmlOpt ...HTMLOptions) ([]byte, error)
- func (r *TplRender) HTMLSetString(setName, tplName string, data interface{}, htmlOpt ...HTMLOptions) (string, error)
- func (r *TplRender) HTMLString(name string, data interface{}, htmlOpt ...HTMLOptions) (string, error)
- func (r *TplRender) HasTemplateSet(name string) bool
- func (r *TplRender) JSON(status int, v interface{})
- func (r *TplRender) JSONString(v interface{}) (string, error)
- func (r *TplRender) PlainText(status int, v []byte)
- func (r *TplRender) RawData(status int, v []byte)
- func (r *TplRender) SetResponseWriter(rw http.ResponseWriter)
- func (r *TplRender) SetTemplatePath(setName, dir string)
- func (r *TplRender) Status(status int)
- func (r *TplRender) XML(status int, v interface{})
- type Tree
Constants ¶
const ( DEV = "development" PROD = "production" TEST = "test" )
const (
DEFAULT_TPL_SET_NAME = "DEFAULT"
)
Variables ¶
var ( ColorLog = true LogTimeFormat = "2006-01-02 15:04:05" )
var ( // Env is the environment that Macaron is executing in. // The MACARON_ENV is read on initialization to set this variable. Env = DEV // Path of work directory. Root string // Flash applies to current request. FlashNow bool )
var MaxMemory = int64(1024 * 1024 * 10)
MaxMemory is the maximum amount of memory to use when parsing a multipart form. Set this to whatever value you prefer; default is 10 MB.
Functions ¶
func Config ¶
func Config() *ini.File
Config returns configuration convention object. It returns an empty object if there is no one available.
func GenerateETag ¶ added in v1.1.12
GenerateETag generates an ETag based on size, filename and file modification time
func GetDefaultListenInfo ¶
func NewRouteMap ¶ added in v1.1.8
func NewRouteMap() *routeMap
NewRouteMap initializes and returns a new routeMap.
func ParseTplSet ¶
func PrepareCharset ¶
Types ¶
type BeforeFunc ¶
type BeforeFunc func(ResponseWriter)
BeforeFunc is a function that is called before the ResponseWriter has been written to.
type BeforeHandler ¶
type BeforeHandler func(rw http.ResponseWriter, req *http.Request) bool
BeforeHandler represents a handler executes at beginning of every request. Macaron stops future process when it returns true.
type ComboRouter ¶ added in v1.1.8
type ComboRouter struct {
// contains filtered or unexported fields
}
ComboRouter represents a combo router.
func (*ComboRouter) Delete ¶ added in v1.1.8
func (cr *ComboRouter) Delete(h ...Handler) *ComboRouter
func (*ComboRouter) Get ¶ added in v1.1.8
func (cr *ComboRouter) Get(h ...Handler) *ComboRouter
func (*ComboRouter) Head ¶ added in v1.1.8
func (cr *ComboRouter) Head(h ...Handler) *ComboRouter
func (*ComboRouter) Name ¶ added in v1.1.8
func (cr *ComboRouter) Name(name string)
Name sets name of ComboRouter route.
func (*ComboRouter) Options ¶ added in v1.1.8
func (cr *ComboRouter) Options(h ...Handler) *ComboRouter
func (*ComboRouter) Patch ¶ added in v1.1.8
func (cr *ComboRouter) Patch(h ...Handler) *ComboRouter
func (*ComboRouter) Post ¶ added in v1.1.8
func (cr *ComboRouter) Post(h ...Handler) *ComboRouter
func (*ComboRouter) Put ¶ added in v1.1.8
func (cr *ComboRouter) Put(h ...Handler) *ComboRouter
type Context ¶
type Context struct { inject.Injector *Router Req Request Resp ResponseWriter Render Locale Data map[string]interface{} // contains filtered or unexported fields }
Context represents the runtime context of current request of Macaron instance. It is the integration of most frequently used middlewares and helper methods.
func (*Context) ChangeStaticPath ¶
ChangeStaticPath changes static path from old to new one.
func (*Context) GetCookieFloat64 ¶
GetCookieFloat64 returns cookie result in float64 type.
func (*Context) GetCookieInt ¶
GetCookieInt returns cookie result in int type.
func (*Context) GetCookieInt64 ¶
GetCookieInt64 returns cookie result in int64 type.
func (*Context) GetFile ¶
GetFile returns information about user upload file by given form field name.
func (*Context) GetSecureCookie ¶
GetSecureCookie returns given cookie value from request header with default secret string.
func (*Context) GetSuperSecureCookie ¶
GetSuperSecureCookie returns given cookie value from request header with secret string.
func (*Context) Params ¶
Params returns value of given param name. e.g. ctx.Params(":uid") or ctx.Params("uid")
func (*Context) ParamsEscape ¶
ParamsEscape returns escapred params result. e.g. ctx.ParamsEscape(":uname")
func (*Context) ParamsFloat64 ¶
ParamsFloat64 returns params result in int64 type. e.g. ctx.ParamsFloat64(":uid")
func (*Context) ParamsInt ¶
ParamsInt returns params result in int type. e.g. ctx.ParamsInt(":uid")
func (*Context) ParamsInt64 ¶
ParamsInt64 returns params result in int64 type. e.g. ctx.ParamsInt64(":uid")
func (*Context) QueryEscape ¶
QueryEscape returns escapred query result.
func (*Context) QueryFloat64 ¶
QueryFloat64 returns query result in float64 type.
func (*Context) QueryInt64 ¶
QueryInt64 returns query result in int64 type.
func (*Context) QueryStrings ¶
QueryStrings returns a list of results by given query name.
func (*Context) RemoteAddr ¶
RemoteAddr returns more real IP address.
func (*Context) ReplaceAllParams ¶ added in v1.2.2
ReplaceAllParams replace all current params with given params
func (*Context) SaveToFile ¶
SaveToFile reads a file from request by field name and saves to given path.
func (*Context) ServeContent ¶
func (ctx *Context) ServeContent(name string, r io.ReadSeeker, params ...interface{})
ServeContent serves given content to response.
func (*Context) ServeFileContent ¶
ServeFileContent serves given file as content to response.
func (*Context) SetCookie ¶
SetCookie sets given cookie value to response header. FIXME: IE support? http://golanghome.com/post/620#reply2
func (*Context) SetSecureCookie ¶
SetSecureCookie sets given cookie value to response header with default secret string.
func (*Context) SetSuperSecureCookie ¶
SetSuperSecureCookie sets given cookie value to response header with secret string.
type ContextInvoker ¶ added in v1.2.0
type ContextInvoker func(ctx *Context)
ContextInvoker is an inject.FastInvoker wrapper of func(ctx *Context).
type Delims ¶
type Delims struct { // Left delimiter, defaults to {{ Left string // Right delimiter, defaults to }} Right string }
Delims represents a set of Left and Right delimiters for HTML template rendering
type DummyRender ¶
type DummyRender struct {
http.ResponseWriter
}
DummyRender is used when user does not choose any real render to use. This way, we can print out friendly message which asks them to register one, instead of ugly and confusing 'nil pointer' panic.
func (*DummyRender) Error ¶
func (r *DummyRender) Error(int, ...string)
func (*DummyRender) HTML ¶
func (r *DummyRender) HTML(int, string, interface{}, ...HTMLOptions)
func (*DummyRender) HTMLBytes ¶
func (r *DummyRender) HTMLBytes(string, interface{}, ...HTMLOptions) ([]byte, error)
func (*DummyRender) HTMLSet ¶
func (r *DummyRender) HTMLSet(int, string, string, interface{}, ...HTMLOptions)
func (*DummyRender) HTMLSetBytes ¶
func (r *DummyRender) HTMLSetBytes(string, string, interface{}, ...HTMLOptions) ([]byte, error)
func (*DummyRender) HTMLSetString ¶
func (r *DummyRender) HTMLSetString(string, string, interface{}, ...HTMLOptions) (string, error)
func (*DummyRender) HTMLString ¶
func (r *DummyRender) HTMLString(string, interface{}, ...HTMLOptions) (string, error)
func (*DummyRender) HasTemplateSet ¶
func (r *DummyRender) HasTemplateSet(string) bool
func (*DummyRender) JSON ¶
func (r *DummyRender) JSON(int, interface{})
func (*DummyRender) JSONString ¶
func (r *DummyRender) JSONString(interface{}) (string, error)
func (*DummyRender) PlainText ¶
func (r *DummyRender) PlainText(int, []byte)
func (*DummyRender) RawData ¶
func (r *DummyRender) RawData(int, []byte)
func (*DummyRender) SetResponseWriter ¶
func (r *DummyRender) SetResponseWriter(http.ResponseWriter)
func (*DummyRender) SetTemplatePath ¶
func (r *DummyRender) SetTemplatePath(string, string)
func (*DummyRender) Status ¶
func (r *DummyRender) Status(int)
func (*DummyRender) XML ¶
func (r *DummyRender) XML(int, interface{})
type HTMLOptions ¶
type HTMLOptions struct { // Layout template name. Overrides Options.Layout. Layout string }
HTMLOptions is a struct for overriding some rendering Options for specific HTML call
type Handle ¶ added in v1.1.8
type Handle func(http.ResponseWriter, *http.Request, Params)
Handle is a function that can be registered to a route to handle HTTP requests. Like http.HandlerFunc, but has a third parameter for the values of wildcards (variables).
type Handler ¶
type Handler interface{}
Handler can be any callable function. Macaron attempts to inject services into the handler's argument list, and panics if an argument could not be fullfilled via dependency injection.
func Logger ¶
func Logger() Handler
Logger returns a middleware handler that logs the request as it goes in and the response as it goes out.
func Recovery ¶
func Recovery() Handler
Recovery returns a middleware that recovers from any panics and writes a 500 if there was one. While Martini is in development mode, Recovery will also output the panic as HTML.
func Renderer ¶
func Renderer(options ...RenderOptions) Handler
Renderer is a Middleware that maps a macaron.Render service into the Macaron handler chain. An single variadic macaron.RenderOptions struct can be optionally provided to configure HTML rendering. The default directory for templates is "templates" and the default file extension is ".tmpl" and ".html".
If MACARON_ENV is set to "" or "development" then templates will be recompiled on every request. For more performance, set the MACARON_ENV environment variable to "production".
func Renderers ¶
func Renderers(options RenderOptions, tplSets ...string) Handler
func Static ¶
func Static(directory string, staticOpt ...StaticOptions) Handler
Static returns a middleware handler that serves static files in the given directory.
func Statics ¶
func Statics(opt StaticOptions, dirs ...string) Handler
Statics registers multiple static middleware handlers all at once.
type Leaf ¶ added in v1.1.8
type Leaf struct {
// contains filtered or unexported fields
}
Leaf represents a leaf route information.
type LoggerInvoker ¶ added in v1.2.0
LoggerInvoker is an inject.FastInvoker wrapper of func(ctx *Context, log *log.Logger).
type Macaron ¶
Macaron represents the top level web application. inject.Injector methods can be invoked to map services on a global level.
func Classic ¶
func Classic() *Macaron
Classic creates a classic Macaron with some basic default middleware: macaron.Logger, macaron.Recovery and macaron.Static.
func New ¶
func New() *Macaron
New creates a bare bones Macaron instance. Use this method if you want to have full control over the middleware that is used.
func NewWithLogger ¶
NewWithLogger creates a bare bones Macaron instance. Use this method if you want to have full control over the middleware that is used. You can specify logger output writer with this function.
func (*Macaron) Action ¶
Action sets the handler that will be called after all the middleware has been invoked. This is set to macaron.Router in a macaron.Classic().
func (*Macaron) Before ¶
func (m *Macaron) Before(handler BeforeHandler)
func (*Macaron) Handlers ¶
Handlers sets the entire middleware stack with the given Handlers. This will clear any current middleware handlers, and panics if any of the handlers is not a callable function
func (*Macaron) Run ¶
func (m *Macaron) Run(args ...interface{})
Run the http server. Listening on os.GetEnv("PORT") or 4000 by default.
func (*Macaron) ServeHTTP ¶
func (m *Macaron) ServeHTTP(rw http.ResponseWriter, req *http.Request)
ServeHTTP is the HTTP Entry point for a Macaron instance. Useful if you want to control your own HTTP server. Be aware that none of middleware will run without registering any router.
func (*Macaron) SetDefaultCookieSecret ¶
SetDefaultCookieSecret sets global default secure cookie secret.
func (*Macaron) SetURLPrefix ¶
SetURLPrefix sets URL prefix of router layer, so that it support suburl.
type Render ¶
type Render interface { http.ResponseWriter SetResponseWriter(http.ResponseWriter) JSON(int, interface{}) JSONString(interface{}) (string, error) RawData(int, []byte) // Serve content as binary PlainText(int, []byte) // Serve content as plain text HTML(int, string, interface{}, ...HTMLOptions) HTMLSet(int, string, string, interface{}, ...HTMLOptions) HTMLSetString(string, string, interface{}, ...HTMLOptions) (string, error) HTMLString(string, interface{}, ...HTMLOptions) (string, error) HTMLSetBytes(string, string, interface{}, ...HTMLOptions) ([]byte, error) HTMLBytes(string, interface{}, ...HTMLOptions) ([]byte, error) XML(int, interface{}) Error(int, ...string) Status(int) SetTemplatePath(string, string) HasTemplateSet(string) bool }
type RenderOptions ¶
type RenderOptions struct { // Directory to load templates. Default is "templates". Directory string // Addtional directories to overwite templates. AppendDirectories []string // Layout template name. Will not render a layout if "". Default is to "". Layout string // Extensions to parse template files from. Defaults are [".tmpl", ".html"]. Extensions []string // Funcs is a slice of FuncMaps to apply to the template upon compilation. This is useful for helper functions. Default is []. Funcs []template.FuncMap // Delims sets the action delimiters to the specified strings in the Delims struct. Delims Delims // Appends the given charset to the Content-Type header. Default is "UTF-8". Charset string // Outputs human readable JSON. IndentJSON bool // Outputs human readable XML. IndentXML bool // Prefixes the JSON output with the given bytes. PrefixJSON []byte // Prefixes the XML output with the given bytes. PrefixXML []byte // Allows changing of output to XHTML instead of HTML. Default is "text/html" HTMLContentType string // TemplateFileSystem is the interface for supporting any implmentation of template file system. TemplateFileSystem }
RenderOptions represents a struct for specifying configuration options for the Render middleware.
type Request ¶
Request represents an HTTP request received by a server or to be sent by a client.
func (*Request) Body ¶
func (r *Request) Body() *RequestBody
Body returns a RequestBody for the request
type RequestBody ¶
type RequestBody struct {
// contains filtered or unexported fields
}
RequestBody represents a request body.
func (*RequestBody) Bytes ¶
func (rb *RequestBody) Bytes() ([]byte, error)
Bytes reads and returns content of request body in bytes.
func (*RequestBody) ReadCloser ¶
func (rb *RequestBody) ReadCloser() io.ReadCloser
ReadCloser returns a ReadCloser for request body.
func (*RequestBody) String ¶
func (rb *RequestBody) String() (string, error)
String reads and returns content of request body in string.
type ResponseWriter ¶
type ResponseWriter interface { http.ResponseWriter http.Flusher http.Pusher // Status returns the status code of the response or 0 if the response has not been written. Status() int // Written returns whether or not the ResponseWriter has been written. Written() bool // Size returns the size of the response body. Size() int // Before allows for a function to be called before the ResponseWriter has been written to. This is // useful for setting headers or any other operations that must happen before a response has been written. Before(BeforeFunc) }
ResponseWriter is a wrapper around http.ResponseWriter that provides extra information about the response. It is recommended that middleware handlers use this construct to wrap a responsewriter if the functionality calls for it.
func NewResponseWriter ¶
func NewResponseWriter(method string, rw http.ResponseWriter) ResponseWriter
NewResponseWriter creates a ResponseWriter that wraps an http.ResponseWriter
type ReturnHandler ¶
ReturnHandler is a service that Martini provides that is called when a route handler returns something. The ReturnHandler is responsible for writing to the ResponseWriter based on the values that are passed into this function.
type Route ¶ added in v1.1.8
type Route struct {
// contains filtered or unexported fields
}
Route represents a wrapper of leaf route and upper level router.
type Router ¶ added in v1.1.8
type Router struct {
// contains filtered or unexported fields
}
Router represents a Macaron router layer.
func (*Router) Combo ¶ added in v1.1.8
func (r *Router) Combo(pattern string, h ...Handler) *ComboRouter
Combo returns a combo router.
func (*Router) Delete ¶ added in v1.1.8
Delete is a shortcut for r.Handle("DELETE", pattern, handlers)
func (*Router) Handle ¶ added in v1.1.8
Handle registers a new request handle with the given pattern, method and handlers.
func (*Router) InternalServerError ¶ added in v1.1.8
InternalServerError configurates handler which is called when route handler returns error. If it is not set, default handler is used. Be sure to set 500 response code in your handler.
func (*Router) NotFound ¶ added in v1.1.8
NotFound configurates http.HandlerFunc which is called when no matching route is found. If it is not set, http.NotFound is used. Be sure to set 404 response code in your handler.
func (*Router) Options ¶ added in v1.1.8
Options is a shortcut for r.Handle("OPTIONS", pattern, handlers)
func (*Router) Patch ¶ added in v1.1.8
Patch is a shortcut for r.Handle("PATCH", pattern, handlers)
func (*Router) Route ¶ added in v1.1.8
Route is a shortcut for same handlers but different HTTP methods.
Example:
m.Route("/", "GET,POST", h)
func (*Router) ServeHTTP ¶ added in v1.1.8
func (r *Router) ServeHTTP(rw http.ResponseWriter, req *http.Request)
func (*Router) SetAutoHead ¶ added in v1.1.8
SetAutoHead sets the value who determines whether add HEAD method automatically when GET method is added.
func (*Router) SetHandlerWrapper ¶ added in v1.2.0
SetHandlerWrapper sets handlerWrapper for the router.
type StaticOptions ¶
type StaticOptions struct { // Prefix is the optional prefix used to serve the static directory content Prefix string // SkipLogging will disable [Static] log messages when a static file is served. SkipLogging bool // IndexFile defines which file to serve as index if it exists. IndexFile string // Expires defines which user-defined function to use for producing a HTTP Expires Header // https://developers.google.com/speed/docs/insights/LeverageBrowserCaching Expires func() string // ETag defines if we should add an ETag header // https://developers.google.com/web/fundamentals/performance/optimizing-content-efficiency/http-caching#validating-cached-responses-with-etags ETag bool // FileSystem is the interface for supporting any implmentation of file system. FileSystem http.FileSystem }
StaticOptions is a struct for specifying configuration options for the macaron.Static middleware.
type TemplateFile ¶
TemplateFile represents a interface of template file that has name and can be read.
type TemplateFileSystem ¶
type TemplateFileSystem interface { ListFiles() []TemplateFile Get(string) (io.Reader, error) }
TemplateFileSystem represents a interface of template file system that able to list all files.
type TemplateSet ¶ added in v1.1.5
type TemplateSet struct {
// contains filtered or unexported fields
}
TemplateSet represents a template set of type *template.Template.
func NewTemplateSet ¶ added in v1.1.5
func NewTemplateSet() *TemplateSet
NewTemplateSet initializes a new empty template set.
func (*TemplateSet) Get ¶ added in v1.1.5
func (ts *TemplateSet) Get(name string) *template.Template
func (*TemplateSet) GetDir ¶ added in v1.1.5
func (ts *TemplateSet) GetDir(name string) string
func (*TemplateSet) Set ¶ added in v1.1.5
func (ts *TemplateSet) Set(name string, opt *RenderOptions) *template.Template
type TplFile ¶
type TplFile struct {
// contains filtered or unexported fields
}
TplFile implements TemplateFile interface.
func NewTplFile ¶
NewTplFile cerates new template file with given name and data.
type TplFileSystem ¶
type TplFileSystem struct {
// contains filtered or unexported fields
}
TplFileSystem implements TemplateFileSystem interface.
func NewTemplateFileSystem ¶
func NewTemplateFileSystem(opt RenderOptions, omitData bool) TplFileSystem
NewTemplateFileSystem creates new template file system with given options.
func (TplFileSystem) Get ¶ added in v1.1.10
func (fs TplFileSystem) Get(name string) (io.Reader, error)
func (TplFileSystem) ListFiles ¶
func (fs TplFileSystem) ListFiles() []TemplateFile
type TplRender ¶
type TplRender struct { http.ResponseWriter *TemplateSet Opt *RenderOptions CompiledCharset string // contains filtered or unexported fields }
func (*TplRender) HTML ¶
func (r *TplRender) HTML(status int, name string, data interface{}, htmlOpt ...HTMLOptions)
func (*TplRender) HTMLBytes ¶
func (r *TplRender) HTMLBytes(name string, data interface{}, htmlOpt ...HTMLOptions) ([]byte, error)
func (*TplRender) HTMLSet ¶
func (r *TplRender) HTMLSet(status int, setName, tplName string, data interface{}, htmlOpt ...HTMLOptions)
func (*TplRender) HTMLSetBytes ¶
func (r *TplRender) HTMLSetBytes(setName, tplName string, data interface{}, htmlOpt ...HTMLOptions) ([]byte, error)
func (*TplRender) HTMLSetString ¶
func (r *TplRender) HTMLSetString(setName, tplName string, data interface{}, htmlOpt ...HTMLOptions) (string, error)
func (*TplRender) HTMLString ¶
func (r *TplRender) HTMLString(name string, data interface{}, htmlOpt ...HTMLOptions) (string, error)
func (*TplRender) HasTemplateSet ¶
func (*TplRender) JSONString ¶
func (*TplRender) SetResponseWriter ¶
func (r *TplRender) SetResponseWriter(rw http.ResponseWriter)
func (*TplRender) SetTemplatePath ¶
type Tree ¶ added in v1.1.8
type Tree struct {
// contains filtered or unexported fields
}
Tree represents a router tree in Macaron.