macaron: github.com/go-macaron/macaron Index | Files

package macaron

import "github.com/go-macaron/macaron"

Package macaron is a high productive and modular web framework in Go.

Index

Package Files

context.go logger.go macaron.go recovery.go render.go response_writer.go return_handler.go router.go static.go tree.go util_go18.go

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)

Maximum amount of memory to use when parsing a multipart form. Set this to whatever value you prefer; default is 10 MB.

func Config Uses

func Config() *ini.File

Config returns configuration convention object. It returns an empty object if there is no one available.

func GenerateETag Uses

func GenerateETag(fileSize, fileName, modTime string) string

GenerateETag generates an ETag based on size, filename and file modification time

func GetDefaultListenInfo Uses

func GetDefaultListenInfo() (string, int)

func GetExt Uses

func GetExt(s string) string

func MatchTest Uses

func MatchTest(pattern, url string) bool

MatchTest returns true if given URL is matched by given pattern.

func NewRouteMap Uses

func NewRouteMap() *routeMap

NewRouteMap initializes and returns a new routeMap.

func ParseTplSet Uses

func ParseTplSet(tplSet string) (tplName string, tplDir string)

func PathUnescape Uses

func PathUnescape(s string) (string, error)

PathUnescape unescapes a path.

func PrepareCharset Uses

func PrepareCharset(charset string) string

func SetConfig Uses

func SetConfig(source interface{}, others ...interface{}) (_ *ini.File, err error)

SetConfig sets data sources for configuration.

func Version Uses

func Version() string

type BeforeFunc Uses

type BeforeFunc func(ResponseWriter)

BeforeFunc is a function that is called before the ResponseWriter has been written to.

type BeforeHandler Uses

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 Uses

type ComboRouter struct {
    // contains filtered or unexported fields
}

ComboRouter represents a combo router.

func (*ComboRouter) Delete Uses

func (cr *ComboRouter) Delete(h ...Handler) *ComboRouter

func (*ComboRouter) Get Uses

func (cr *ComboRouter) Get(h ...Handler) *ComboRouter

func (*ComboRouter) Head Uses

func (cr *ComboRouter) Head(h ...Handler) *ComboRouter

func (*ComboRouter) Name Uses

func (cr *ComboRouter) Name(name string)

Name sets name of ComboRouter route.

func (*ComboRouter) Options Uses

func (cr *ComboRouter) Options(h ...Handler) *ComboRouter

func (*ComboRouter) Patch Uses

func (cr *ComboRouter) Patch(h ...Handler) *ComboRouter

func (*ComboRouter) Post Uses

func (cr *ComboRouter) Post(h ...Handler) *ComboRouter

func (*ComboRouter) Put Uses

func (cr *ComboRouter) Put(h ...Handler) *ComboRouter

type Context Uses

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 Uses

func (ctx *Context) ChangeStaticPath(oldPath, newPath string)

ChangeStaticPath changes static path from old to new one.

func (*Context) GetCookie Uses

func (ctx *Context) GetCookie(name string) string

GetCookie returns given cookie value from request header.

func (*Context) GetCookieFloat64 Uses

func (ctx *Context) GetCookieFloat64(name string) float64

GetCookieFloat64 returns cookie result in float64 type.

func (*Context) GetCookieInt Uses

func (ctx *Context) GetCookieInt(name string) int

GetCookieInt returns cookie result in int type.

func (*Context) GetCookieInt64 Uses

func (ctx *Context) GetCookieInt64(name string) int64

GetCookieInt64 returns cookie result in int64 type.

func (*Context) GetFile Uses

func (ctx *Context) GetFile(name string) (multipart.File, *multipart.FileHeader, error)

GetFile returns information about user upload file by given form field name.

func (*Context) GetSecureCookie Uses

func (ctx *Context) GetSecureCookie(key string) (string, bool)

GetSecureCookie returns given cookie value from request header with default secret string.

func (*Context) GetSuperSecureCookie Uses

func (ctx *Context) GetSuperSecureCookie(secret, name string) (string, bool)

GetSuperSecureCookie returns given cookie value from request header with secret string.

func (*Context) HTML Uses

func (ctx *Context) HTML(status int, name string, data ...interface{})

HTML calls Render.HTML but allows less arguments.

func (*Context) HTMLSet Uses

func (ctx *Context) HTMLSet(status int, setName, tplName string, data ...interface{})

HTML calls Render.HTMLSet but allows less arguments.

func (*Context) Next Uses

func (c *Context) Next()

func (*Context) Params Uses

func (ctx *Context) Params(name string) string

Params returns value of given param name. e.g. ctx.Params(":uid") or ctx.Params("uid")

func (*Context) ParamsEscape Uses

func (ctx *Context) ParamsEscape(name string) string

ParamsEscape returns escapred params result. e.g. ctx.ParamsEscape(":uname")

func (*Context) ParamsFloat64 Uses

func (ctx *Context) ParamsFloat64(name string) float64

ParamsFloat64 returns params result in int64 type. e.g. ctx.ParamsFloat64(":uid")

func (*Context) ParamsInt Uses

func (ctx *Context) ParamsInt(name string) int

ParamsInt returns params result in int type. e.g. ctx.ParamsInt(":uid")

func (*Context) ParamsInt64 Uses

func (ctx *Context) ParamsInt64(name string) int64

ParamsInt64 returns params result in int64 type. e.g. ctx.ParamsInt64(":uid")

func (*Context) Query Uses

func (ctx *Context) Query(name string) string

Query querys form parameter.

func (*Context) QueryBool Uses

func (ctx *Context) QueryBool(name string) bool

QueryBool returns query result in bool type.

func (*Context) QueryEscape Uses

func (ctx *Context) QueryEscape(name string) string

QueryEscape returns escapred query result.

func (*Context) QueryFloat64 Uses

func (ctx *Context) QueryFloat64(name string) float64

QueryFloat64 returns query result in float64 type.

func (*Context) QueryInt Uses

func (ctx *Context) QueryInt(name string) int

QueryInt returns query result in int type.

func (*Context) QueryInt64 Uses

func (ctx *Context) QueryInt64(name string) int64

QueryInt64 returns query result in int64 type.

func (*Context) QueryStrings Uses

func (ctx *Context) QueryStrings(name string) []string

QueryStrings returns a list of results by given query name.

func (*Context) QueryTrim Uses

func (ctx *Context) QueryTrim(name string) string

QueryTrim querys and trims spaces form parameter.

func (*Context) Redirect Uses

func (ctx *Context) Redirect(location string, status ...int)

func (*Context) RemoteAddr Uses

func (ctx *Context) RemoteAddr() string

RemoteAddr returns more real IP address.

func (*Context) ReplaceAllParams Uses

func (ctx *Context) ReplaceAllParams(params Params)

ReplaceAllParams replace all current params with given params

func (*Context) SaveToFile Uses

func (ctx *Context) SaveToFile(name, savePath string) error

SaveToFile reads a file from request by field name and saves to given path.

func (*Context) ServeContent Uses

func (ctx *Context) ServeContent(name string, r io.ReadSeeker, params ...interface{})

ServeContent serves given content to response.

func (*Context) ServeFile Uses

func (ctx *Context) ServeFile(file string, names ...string)

ServeFile serves given file to response.

func (*Context) ServeFileContent Uses

func (ctx *Context) ServeFileContent(file string, names ...string)

ServeFileContent serves given file as content to response.

func (*Context) SetCookie Uses

func (ctx *Context) SetCookie(name string, value string, others ...interface{})

SetCookie sets given cookie value to response header. FIXME: IE support? http://golanghome.com/post/620#reply2

func (*Context) SetParams Uses

func (ctx *Context) SetParams(name, val string)

SetParams sets value of param with given name.

func (*Context) SetSecureCookie Uses

func (ctx *Context) SetSecureCookie(name, value string, others ...interface{})

SetSecureCookie sets given cookie value to response header with default secret string.

func (*Context) SetSuperSecureCookie Uses

func (ctx *Context) SetSuperSecureCookie(secret, name, value string, others ...interface{})

SetSuperSecureCookie sets given cookie value to response header with secret string.

func (*Context) Written Uses

func (c *Context) Written() bool

type ContextInvoker Uses

type ContextInvoker func(ctx *Context)

ContextInvoker is an inject.FastInvoker wrapper of func(ctx *Context).

func (ContextInvoker) Invoke Uses

func (invoke ContextInvoker) Invoke(params []interface{}) ([]reflect.Value, error)

type Delims Uses

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 Uses

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 Uses

func (r *DummyRender) Error(int, ...string)

func (*DummyRender) HTML Uses

func (r *DummyRender) HTML(int, string, interface{}, ...HTMLOptions)

func (*DummyRender) HTMLBytes Uses

func (r *DummyRender) HTMLBytes(string, interface{}, ...HTMLOptions) ([]byte, error)

func (*DummyRender) HTMLSet Uses

func (r *DummyRender) HTMLSet(int, string, string, interface{}, ...HTMLOptions)

func (*DummyRender) HTMLSetBytes Uses

func (r *DummyRender) HTMLSetBytes(string, string, interface{}, ...HTMLOptions) ([]byte, error)

func (*DummyRender) HTMLSetString Uses

func (r *DummyRender) HTMLSetString(string, string, interface{}, ...HTMLOptions) (string, error)

func (*DummyRender) HTMLString Uses

func (r *DummyRender) HTMLString(string, interface{}, ...HTMLOptions) (string, error)

func (*DummyRender) HasTemplateSet Uses

func (r *DummyRender) HasTemplateSet(string) bool

func (*DummyRender) JSON Uses

func (r *DummyRender) JSON(int, interface{})

func (*DummyRender) JSONString Uses

func (r *DummyRender) JSONString(interface{}) (string, error)

func (*DummyRender) PlainText Uses

func (r *DummyRender) PlainText(int, []byte)

func (*DummyRender) RawData Uses

func (r *DummyRender) RawData(int, []byte)

func (*DummyRender) SetResponseWriter Uses

func (r *DummyRender) SetResponseWriter(http.ResponseWriter)

func (*DummyRender) SetTemplatePath Uses

func (r *DummyRender) SetTemplatePath(string, string)

func (*DummyRender) Status Uses

func (r *DummyRender) Status(int)

func (*DummyRender) XML Uses

func (r *DummyRender) XML(int, interface{})

type HTMLOptions Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

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 Uses

func Renderers(options RenderOptions, tplSets ...string) Handler

func Static Uses

func Static(directory string, staticOpt ...StaticOptions) Handler

Static returns a middleware handler that serves static files in the given directory.

func Statics Uses

func Statics(opt StaticOptions, dirs ...string) Handler

Statics registers multiple static middleware handlers all at once.

type Leaf Uses

type Leaf struct {
    // contains filtered or unexported fields
}

Leaf represents a leaf route information.

func NewLeaf Uses

func NewLeaf(parent *Tree, pattern string, handle Handle) *Leaf

func (*Leaf) URLPath Uses

func (l *Leaf) URLPath(pairs ...string) string

URLPath build path part of URL by given pair values.

type Locale Uses

type Locale interface {
    Language() string
    Tr(string, ...interface{}) string
}

Locale reprents a localization interface.

type LoggerInvoker Uses

type LoggerInvoker func(ctx *Context, log *log.Logger)

LoggerInvoker is an inject.FastInvoker wrapper of func(ctx *Context, log *log.Logger).

func (LoggerInvoker) Invoke Uses

func (invoke LoggerInvoker) Invoke(params []interface{}) ([]reflect.Value, error)

type Macaron Uses

type Macaron struct {
    inject.Injector

    *Router
    // contains filtered or unexported fields
}

Macaron represents the top level web application. inject.Injector methods can be invoked to map services on a global level.

func Classic Uses

func Classic() *Macaron

Classic creates a classic Macaron with some basic default middleware: macaron.Logger, macaron.Recovery and macaron.Static.

func New Uses

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 Uses

func NewWithLogger(out io.Writer) *Macaron

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 Uses

func (m *Macaron) Action(handler Handler)

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 Uses

func (m *Macaron) Before(handler BeforeHandler)

func (*Macaron) Handlers Uses

func (m *Macaron) Handlers(handlers ...Handler)

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 Uses

func (m *Macaron) Run(args ...interface{})

Run the http server. Listening on os.GetEnv("PORT") or 4000 by default.

func (*Macaron) ServeHTTP Uses

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 Uses

func (m *Macaron) SetDefaultCookieSecret(secret string)

SetDefaultCookieSecret sets global default secure cookie secret.

func (*Macaron) SetURLPrefix Uses

func (m *Macaron) SetURLPrefix(prefix string)

SetURLPrefix sets URL prefix of router layer, so that it support suburl.

func (*Macaron) Use Uses

func (m *Macaron) Use(handler Handler)

Use adds a middleware Handler to the stack, and panics if the handler is not a callable func. Middleware Handlers are invoked in the order that they are added.

type Params Uses

type Params map[string]string

type Render Uses

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 Uses

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 Uses

type Request struct {
    *http.Request
}

Request represents an HTTP request received by a server or to be sent by a client.

func (*Request) Body Uses

func (r *Request) Body() *RequestBody

type RequestBody Uses

type RequestBody struct {
    // contains filtered or unexported fields
}

RequestBody represents a request body.

func (*RequestBody) Bytes Uses

func (rb *RequestBody) Bytes() ([]byte, error)

Bytes reads and returns content of request body in bytes.

func (*RequestBody) ReadCloser Uses

func (rb *RequestBody) ReadCloser() io.ReadCloser

ReadCloser returns a ReadCloser for request body.

func (*RequestBody) String Uses

func (rb *RequestBody) String() (string, error)

String reads and returns content of request body in string.

type ResponseWriter Uses

type ResponseWriter interface {
    http.ResponseWriter
    http.Flusher
    // 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 Uses

func NewResponseWriter(method string, rw http.ResponseWriter) ResponseWriter

NewResponseWriter creates a ResponseWriter that wraps an http.ResponseWriter

type ReturnHandler Uses

type ReturnHandler func(*Context, []reflect.Value)

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 Uses

type Route struct {
    // contains filtered or unexported fields
}

Route represents a wrapper of leaf route and upper level router.

func (*Route) Name Uses

func (r *Route) Name(name string)

Name sets name of route.

type Router Uses

type Router struct {
    // contains filtered or unexported fields
}

Router represents a Macaron router layer.

func NewRouter Uses

func NewRouter() *Router

func (*Router) Any Uses

func (r *Router) Any(pattern string, h ...Handler) *Route

Any is a shortcut for r.Handle("*", pattern, handlers)

func (*Router) Combo Uses

func (r *Router) Combo(pattern string, h ...Handler) *ComboRouter

Combo returns a combo router.

func (*Router) Delete Uses

func (r *Router) Delete(pattern string, h ...Handler) *Route

Delete is a shortcut for r.Handle("DELETE", pattern, handlers)

func (*Router) Get Uses

func (r *Router) Get(pattern string, h ...Handler) (leaf *Route)

Get is a shortcut for r.Handle("GET", pattern, handlers)

func (*Router) Group Uses

func (r *Router) Group(pattern string, fn func(), h ...Handler)

func (*Router) Handle Uses

func (r *Router) Handle(method string, pattern string, handlers []Handler) *Route

Handle registers a new request handle with the given pattern, method and handlers.

func (*Router) Head Uses

func (r *Router) Head(pattern string, h ...Handler) *Route

Head is a shortcut for r.Handle("HEAD", pattern, handlers)

func (*Router) InternalServerError Uses

func (r *Router) InternalServerError(handlers ...Handler)

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 Uses

func (r *Router) NotFound(handlers ...Handler)

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 Uses

func (r *Router) Options(pattern string, h ...Handler) *Route

Options is a shortcut for r.Handle("OPTIONS", pattern, handlers)

func (*Router) Patch Uses

func (r *Router) Patch(pattern string, h ...Handler) *Route

Patch is a shortcut for r.Handle("PATCH", pattern, handlers)

func (*Router) Post Uses

func (r *Router) Post(pattern string, h ...Handler) *Route

Post is a shortcut for r.Handle("POST", pattern, handlers)

func (*Router) Put Uses

func (r *Router) Put(pattern string, h ...Handler) *Route

Put is a shortcut for r.Handle("PUT", pattern, handlers)

func (*Router) Route Uses

func (r *Router) Route(pattern, methods string, h ...Handler) (route *Route)

Route is a shortcut for same handlers but different HTTP methods.

Example:

m.Route("/", "GET,POST", h)

func (*Router) ServeHTTP Uses

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

func (*Router) SetAutoHead Uses

func (r *Router) SetAutoHead(v bool)

SetAutoHead sets the value who determines whether add HEAD method automatically when GET method is added.

func (*Router) SetHandlerWrapper Uses

func (r *Router) SetHandlerWrapper(f func(Handler) Handler)

SetHandlerWrapper sets handlerWrapper for the router.

func (*Router) URLFor Uses

func (r *Router) URLFor(name string, pairs ...string) string

URLFor builds path part of URL by given pair values.

type StaticOptions Uses

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 Uses

type TemplateFile interface {
    Name() string
    Data() []byte
    Ext() string
}

TemplateFile represents a interface of template file that has name and can be read.

type TemplateFileSystem Uses

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 Uses

type TemplateSet struct {
    // contains filtered or unexported fields
}

TemplateSet represents a template set of type *template.Template.

func NewTemplateSet Uses

func NewTemplateSet() *TemplateSet

NewTemplateSet initializes a new empty template set.

func (*TemplateSet) Get Uses

func (ts *TemplateSet) Get(name string) *template.Template

func (*TemplateSet) GetDir Uses

func (ts *TemplateSet) GetDir(name string) string

func (*TemplateSet) Set Uses

func (ts *TemplateSet) Set(name string, opt *RenderOptions) *template.Template

type TplFile Uses

type TplFile struct {
    // contains filtered or unexported fields
}

TplFile implements TemplateFile interface.

func NewTplFile Uses

func NewTplFile(name string, data []byte, ext string) *TplFile

NewTplFile cerates new template file with given name and data.

func (*TplFile) Data Uses

func (f *TplFile) Data() []byte

func (*TplFile) Ext Uses

func (f *TplFile) Ext() string

func (*TplFile) Name Uses

func (f *TplFile) Name() string

type TplFileSystem Uses

type TplFileSystem struct {
    // contains filtered or unexported fields
}

TplFileSystem implements TemplateFileSystem interface.

func NewTemplateFileSystem Uses

func NewTemplateFileSystem(opt RenderOptions, omitData bool) TplFileSystem

NewTemplateFileSystem creates new template file system with given options.

func (TplFileSystem) Get Uses

func (fs TplFileSystem) Get(name string) (io.Reader, error)

func (TplFileSystem) ListFiles Uses

func (fs TplFileSystem) ListFiles() []TemplateFile

type TplRender Uses

type TplRender struct {
    http.ResponseWriter
    *TemplateSet
    Opt             *RenderOptions
    CompiledCharset string
    // contains filtered or unexported fields
}

func (*TplRender) Error Uses

func (r *TplRender) Error(status int, message ...string)

Error writes the given HTTP status to the current ResponseWriter

func (*TplRender) HTML Uses

func (r *TplRender) HTML(status int, name string, data interface{}, htmlOpt ...HTMLOptions)

func (*TplRender) HTMLBytes Uses

func (r *TplRender) HTMLBytes(name string, data interface{}, htmlOpt ...HTMLOptions) ([]byte, error)

func (*TplRender) HTMLSet Uses

func (r *TplRender) HTMLSet(status int, setName, tplName string, data interface{}, htmlOpt ...HTMLOptions)

func (*TplRender) HTMLSetBytes Uses

func (r *TplRender) HTMLSetBytes(setName, tplName string, data interface{}, htmlOpt ...HTMLOptions) ([]byte, error)

func (*TplRender) HTMLSetString Uses

func (r *TplRender) HTMLSetString(setName, tplName string, data interface{}, htmlOpt ...HTMLOptions) (string, error)

func (*TplRender) HTMLString Uses

func (r *TplRender) HTMLString(name string, data interface{}, htmlOpt ...HTMLOptions) (string, error)

func (*TplRender) HasTemplateSet Uses

func (r *TplRender) HasTemplateSet(name string) bool

func (*TplRender) JSON Uses

func (r *TplRender) JSON(status int, v interface{})

func (*TplRender) JSONString Uses

func (r *TplRender) JSONString(v interface{}) (string, error)

func (*TplRender) PlainText Uses

func (r *TplRender) PlainText(status int, v []byte)

func (*TplRender) RawData Uses

func (r *TplRender) RawData(status int, v []byte)

func (*TplRender) SetResponseWriter Uses

func (r *TplRender) SetResponseWriter(rw http.ResponseWriter)

func (*TplRender) SetTemplatePath Uses

func (r *TplRender) SetTemplatePath(setName, dir string)

func (*TplRender) Status Uses

func (r *TplRender) Status(status int)

func (*TplRender) XML Uses

func (r *TplRender) XML(status int, v interface{})

type Tree Uses

type Tree struct {
    // contains filtered or unexported fields
}

Tree represents a router tree in Macaron.

func NewSubtree Uses

func NewSubtree(parent *Tree, pattern string) *Tree

func NewTree Uses

func NewTree() *Tree

func (*Tree) Add Uses

func (t *Tree) Add(pattern string, handle Handle) *Leaf

func (*Tree) Match Uses

func (t *Tree) Match(url string) (Handle, Params, bool)

Package macaron imports 30 packages (graph) and is imported by 12 packages. Updated 2018-09-11. Refresh now. Tools for package owners.