snap

package module

Go to main page

Versions in this module

v0

v0.2.2

Jun 10, 2024

Changes in this version

type Server

+ func (s *Server) WithVersion(version int64) *Server

type SnapContent

+ Version int64

v0.2.1

Apr 16, 2024

Changes in this version

type Server

+ func (s *Server) SetLogger(logger log.Logger)

v0.2.0

Apr 16, 2024

Changes in this version

+ func Redirect(to string) func(c *Context)

+ func Walk(fs http.FileSystem, base string, ...) error

+ type CompoundOptions struct

+ func (c *CompoundOptions) Get(key string) (string, bool)

+ type Context struct

+ func (c *Context) Error(code int, msg string)

+ func (c *Context) ErrorObject(code int, obj interface{})

+ func (c *Context) Form() (*Options, error)

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

+ func (c *Context) GetRequest() *http.Request

+ func (c *Context) GetUser() string

+ func (c *Context) ParseVars() *Options

+ func (c *Context) QueryHas(key string) bool

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

+ func (c *Context) QueryValueWithDefault(key string, def string) string

+ func (c *Context) ReadObject(object interface{}) error

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

+ func (c *Context) Render(tmpl string, content interface{})

+ func (c *Context) RenderEx(tmpl string, content interface{})

+ func (c *Context) RenderWithMeta(tmpl string, meta map[string]string, content interface{})

+ func (c *Context) Reply(msg string)

+ func (c *Context) ReplyObject(obj interface{})

+ func (c *Context) ReplyWithHeaders(msg string, kv map[string]string)

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

+ type Form struct

+ func (f *Form) Get(k string) (string, bool)

+ type FormValueProvider interface

+ FormValue func(string) string

+ type Options struct

+ func (o *Options) GetVar(k string) (string, bool)

+ func (o *Options) GetVarAsSlice(k string, delim string, def []string) []string

+ func (o *Options) GetVarDefault(k string, def string) string

+ func (o *Options) StringSlice(k string, delim string) ([]string, bool)

+ func (o *Options) StringValue(k string) (string, bool)

+ func (o *Options) TimeValue(key, timeFormat string, defaultValue *time.Time) time.Time

+ func (o *Options) Uint64Value(k string) (uint64, bool)

+ type OptionsProvider interface

+ Get func(key string) (string, bool)

+ type Query struct

+ Values url.Values

+ func (q *Query) Get(key string) (string, bool)

+ type RouteBuilder struct

+ func NewRouteBuilder() *RouteBuilder

+ func (r *RouteBuilder) BuildRoute(s *Server) http.HandlerFunc

+ func (r *RouteBuilder) WithAuth(auth auth.Authenticator) *RouteBuilder

+ func (r *RouteBuilder) WithContent(contentHandler func(c *Context)) *RouteBuilder

+ func (r *RouteBuilder) WithLoginHandler(loginHandler func(c *Context) bool) *RouteBuilder

+ type Server struct

+ func New(address string, path string, auth auth.Authenticator) *Server

+ func (s *Server) AddRoute(path string, r *RouteBuilder) *mux.Route

+ func (s *Server) Dump()

+ func (s *Server) EnableStatus(path string)

+ func (s *Server) EnableTestMode(enable bool) *Server

+ func (s *Server) HandleFunc(path string, f func(c *Context)) *mux.Route

+ func (s *Server) HandleFuncAuthenticated(path, redirect string, f func(c *Context)) *mux.Route

+ func (s *Server) HandleFuncAuthenticatedWithLogin(path string, loginHandler func(c *Context) bool, ...) *mux.Route

+ func (s *Server) HandleFuncCustomAuth(auth auth.Authenticator, path, redirect string, f func(c *Context)) *mux.Route

+ func (s *Server) HandleServiceFunc(path string, f func(c *ServiceRequest) *ServiceResponse) *mux.Route

+ func (s *Server) HandleServiceFuncWithAuth(path string, f func(c *ServiceRequest) *ServiceResponse) *mux.Route

+ func (s *Server) LoadTemplatesFS(fs http.FileSystem, base string) (*template.Template, error)

+ func (s *Server) Router() *mux.Router

+ func (s *Server) Serve() error

+ func (s *Server) ServeTLS(keyPath string, certPath string) error

+ func (s *Server) ServeTLSRedirect(address string) error

+ func (s *Server) SetDebug(enable bool)

+ func (s *Server) SetTemplatePath(tmplPath string)

+ func (s *Server) SetTheme(themePath string)

+ func (s *Server) Shutdown(ctx context.Context)

+ func (s *Server) WithAuth(auth auth.Authenticator) *Server

+ func (s *Server) WithDebug(debugURL string) *Server

+ func (s *Server) WithHealthCheck(version, date string, status func() (bool, string))

+ func (s *Server) WithMetadata(meta map[string]string) *Server

+ func (s *Server) WithRootFileSystem(fs http.FileSystem) *Server

+ func (s *Server) WithStaticFiles(prefix string) *Server

+ func (s *Server) WithTemplateFuncs(funcs template.FuncMap) *Server

+ func (s *Server) WithTheme(themeURL string) *Server

+ type ServiceRequest struct

+ func (c *ServiceRequest) Form() (*Options, error)

+ func (c *ServiceRequest) GetObject(object interface{}) error

+ func (c *ServiceRequest) GetRequest() *http.Request

+ func (c *ServiceRequest) GetUser() string

+ func (c *ServiceRequest) Options() *Options

+ func (c *ServiceRequest) Query() *Options

+ func (c *ServiceRequest) ReplyMessage(code int, msg string) *ServiceResponse

+ func (c *ServiceRequest) ReplyObject(code int, obj interface{}) *ServiceResponse

+ func (c *ServiceRequest) Vars() *Options

+ type ServiceResponse struct

+ Code int

+ Message []byte

+ func (s *ServiceResponse) WriteResponse(w http.ResponseWriter)

+ type ServiceStatus struct

+ Message string

+ type SnapBaseContent struct

+ Content interface{}

+ Theme string

+ type SnapContent struct

+ Content interface{}

+ Meta map[string]string

+ Theme string

+ User string

+ UserProperties map[string]string

+ type Vars struct

+ func (c Vars) Get(k string) (string, bool)

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