web

package

Go to main page

Versions in this module

v1

v1.20240719.1

Jul 19, 2024

Changes in this version

type TLSOption

+ func OptTLSAppendCACertsFromPaths(paths ...string) TLSOption

v1.20220411.3

Apr 11, 2022

Changes in this version

type Action

+ func SessionAwareForLogout(action Action) Action

type AuthManager

+ func (am AuthManager) VerifyOrExtendSession(ctx *Ctx) (session *Session, err error)

v1.20220212.5

Feb 12, 2022

v1.20220207.10

Feb 7, 2022

v1.20220204.2

Feb 4, 2022

v1.20220129.5

Jan 29, 2022

v1.20220112.5

Jan 12, 2022

v1.20211204.3

Dec 4, 2021

v1.20211025.3

Oct 25, 2021

Changes in this version

+ type RouteTree struct

+ MethodNotAllowedHandler Handler

+ NotFoundHandler Handler

+ Routes map[string]*RouteNode

+ SkipHandlingMethodOptions bool

+ SkipMethodNotAllowed bool

+ SkipTrailingSlashRedirects bool

+ func (rt *RouteTree) Handle(method, path string, handler Handler)

+ func (rt *RouteTree) Route(req *http.Request) (*Route, RouteParameters)

+ func (rt *RouteTree) ServeHTTP(w http.ResponseWriter, req *http.Request)

v1.20211016.2

Oct 16, 2021

v1.20210918.2

Sep 18, 2021

v1.20210917.5

Sep 17, 2021

Changes in this version

type Option

+ func OptBaseContext(ctx context.Context) Option

+ func OptBaseContextFunc(bc func(net.Listener) context.Context) Option

v1.20210908.5

Sep 8, 2021

Changes in this version

type Option

+ func OptBaseURL(baseURL string) Option

type RouteNode

+ func (n *RouteNode) AddRoute(method, path string, handler Handler)

+ func (n *RouteNode) GetPath(path string) (route *Route, p RouteParameters, tsr bool)

v1.20210826.18

Aug 26, 2021

v1.20210819.9

Aug 19, 2021

v1.20210818.6

Aug 18, 2021

v1.20210818.2

Aug 18, 2021

v1.20210815.2

Aug 15, 2021

v1.20210806.4

Aug 6, 2021

v1.20210731.3

Jul 31, 2021

v1.20210731.2

Jul 31, 2021

v1.20210731.1

Jul 31, 2021

v1.20210730.3

Jul 30, 2021

v1.20210727.18

Jul 27, 2021

v1.20210727.11

Jul 27, 2021

v1.20210727.10

Jul 27, 2021

v1.20210727.1

Jul 27, 2021

v1.20210722.4

Jul 22, 2021

v1.20210720.3

Jul 20, 2021

v1.20210713.1

Jul 13, 2021

v1.20210708.9

Jul 8, 2021

v1.20210708.4

Jul 8, 2021

v1.20210708.3

Jul 8, 2021

v1.20210701.2

Jul 1, 2021

v1.20210616.2

Jun 16, 2021

v1.20210615.7

Jun 15, 2021

v1.20210603.3

Jun 3, 2021

v1.20210518.1

May 18, 2021

v1.20210517.3

May 17, 2021

v1.20210428.4

Apr 28, 2021

v1.20210413.2

Apr 13, 2021

v1.20210410.1

Apr 10, 2021

v1.20210406.3

Apr 6, 2021

v1.20210402.4

Apr 2, 2021

v1.20210402.3

Apr 2, 2021

v1.20210402.2

Apr 2, 2021

v1.20210316.2

Mar 16, 2021

v1.20210309.4

Mar 9, 2021

v1.20210306.3

Mar 6, 2021

Changes in this version

type AuthManager

+ SerializeHandler AuthManagerSerializeSessionHandler

+ type AuthManagerFetchSessionHandler func(context.Context, string) (*Session, error)

type AuthManagerOption

+ func OptAuthManagerSerializeHandler(handler AuthManagerSerializeSessionHandler) AuthManagerOption

+ type AuthManagerPersistSessionHandler func(context.Context, *Session) error

+ type AuthManagerRemoveSessionHandler func(context.Context, string) error

+ type AuthManagerSerializeSessionHandler func(context.Context, *Session) (string, error)

+ type AuthManagerValidateSessionHandler func(context.Context, *Session) error

type JWTManager

+ func (jwtm JWTManager) FetchHandler(_ context.Context, sessionValue string) (*Session, error)

+ func (jwtm JWTManager) SerializeHandler(_ context.Context, session *Session) (output string, err error)

v1.20210306.2

Mar 6, 2021

v1.20210227.3

Feb 27, 2021

v1.20210222.1

Feb 22, 2021

Changes in this version

+ const DefaultCookieSameSiteMode

v1.20210221.5

Feb 21, 2021

v1.20210221.4

Feb 21, 2021

v1.20210220.2

Feb 20, 2021

v1.20210216.3

Feb 16, 2021

v1.20210216.2

Feb 16, 2021

v1.20210216.1

Feb 16, 2021

Changes in this version

+ func UUIDValue(param string, inputErr error) (uuid.UUID, error)

v1.20210215.2

Feb 15, 2021

Changes in this version

+ func MockSimulateLogin(ctx context.Context, app *App, userID string, opts ...r2.Option) []r2.Option

type Option

+ func OptIdleTimeout(d time.Duration) Option

+ func OptMaxHeaderBytes(maxHeaderBytes int) Option

+ func OptReadHeaderTimeout(d time.Duration) Option

+ func OptReadTimeout(d time.Duration) Option

+ func OptWriteTimeout(d time.Duration) Option

v1.20210205.5

Feb 5, 2021

v1.20210204.2

Feb 4, 2021

v1.20210201.1

Feb 1, 2021

Changes in this version

type CachedStaticFile

+ func NewCachedStaticFile(path string) (*CachedStaticFile, error)

type Config

+ func (c Config) IsZero() bool

type Ctx

+ func MockCtxWithBuffer(method, path string, buf io.Writer, options ...CtxOption) *Ctx

v1.20210116.5

Jan 16, 2021

v1.20210116.4

Jan 16, 2021

v1.20210116.3

Jan 16, 2021

v1.20210104.2

Jan 4, 2021

Changes in this version

+ var ErrInvalidBoolValue = fmt.Errorf("invalid boolean value")

type Config

+ func (c Config) ResolveCookieDomain(_ context.Context) (*string, error)

+ func (c Config) ResolveCookieSecure(_ context.Context) (*bool, error)

v1.20210104.1

Jan 3, 2021

v1.20210103.1

Jan 3, 2021

Changes in this version

type JWTManager

+ func (jwtm JWTManager) Apply(am *AuthManager)

type LocalSessionCache

+ func (lsc *LocalSessionCache) Apply(am *AuthManager)

type MockResult

+ func MockPostJSON(app *App, path string, body interface{}, options ...r2.Option) *MockResult

v1.20201204.1

Dec 4, 2020

Changes in this version

+ const DefaultCookieHTTPOnly

+ const DefaultCookieSecure

+ const DefaultKeepAlive

+ const DefaultKeepAlivePeriod

+ const DefaultMockBindAddr

+ const DefaultSkipRedirectTrailingSlash

+ const ErrParameterInvalid

+ const FieldTagPostForm

+ func BaseHeaders() http.Header

+ func CopyHeaders(headers http.Header) http.Header

+ func CopySingleHeaders(headers map[string]string) http.Header

+ func ExtractHost(hostport string) string

+ func GetRequestStarted(ctx context.Context) time.Time

+ func IsErrBadRequest(err error) bool

+ func IsErrParameterInvalid(err error) bool

+ func IsErrParameterMissing(err error) bool

+ func MergeHeaders(headers ...http.Header) http.Header

+ func NewParameterInvalidError(paramName, message string) error

+ func NewParameterMissingError(paramName string) error

+ func NewRequestID() string

+ func WithApp(ctx context.Context, app *App) context.Context

+ func WithRequestStarted(ctx context.Context, requestStarted time.Time) context.Context

+ func WithSession(ctx context.Context, session *Session) context.Context

type Action

+ func GZip(action Action) Action

type App

+ BaseContext func(net.Listener) context.Context

+ BaseHeaders http.Header

+ BaseMiddleware []Middleware

+ BaseState State

+ DefaultProvider ResultProvider

+ Log logger.Log

+ Routes map[string]*RouteNode

+ Statics map[string]*StaticFileServer

+ func GetApp(ctx context.Context) *App

+ func MustNew(options ...Option) *App

+ func (a *App) Background() context.Context

+ func (a *App) Method(method string, path string, action Action, middleware ...Middleware)

+ func (a *App) MethodBare(method string, path string, action Action, middleware ...Middleware)

+ func (a *App) RenderAction(action Action) Handler

+ func (a *App) RenderActionBare(action Action) Handler

type AuthManager

+ CookieDefaults http.Cookie

+ func MustNewAuthManager(options ...AuthManagerOption) AuthManager

+ func NewAuthManager(options ...AuthManagerOption) (manager AuthManager, err error)

+ func (am AuthManager) VerifyOrExpireSession(ctx *Ctx) (session *Session, err error)

+ func (am AuthManager) VerifySessionValue(ctx *Ctx, sessionValue string) (session *Session, err error)

+ type AuthManagerOption func(*AuthManager) error

+ func OptAuthManagerCookieDefaults(cookie http.Cookie) AuthManagerOption

+ func OptAuthManagerCookieDomain(domain string) AuthManagerOption

+ func OptAuthManagerCookieHTTPOnly(httpOnly bool) AuthManagerOption

+ func OptAuthManagerCookieName(cookieName string) AuthManagerOption

+ func OptAuthManagerCookiePath(cookiePath string) AuthManagerOption

+ func OptAuthManagerCookieSameSite(sameSite http.SameSite) AuthManagerOption

+ func OptAuthManagerCookieSecure(secure bool) AuthManagerOption

+ func OptAuthManagerFetchHandler(handler AuthManagerFetchHandler) AuthManagerOption

+ func OptAuthManagerFromConfig(cfg Config) AuthManagerOption

+ func OptAuthManagerLoginRedirectHandler(handler AuthManagerRedirectHandler) AuthManagerOption

+ func OptAuthManagerParseSessionValueHandler(handler AuthManagerParseSessionValueHandler) AuthManagerOption

+ func OptAuthManagerPersistHandler(handler AuthManagerPersistHandler) AuthManagerOption

+ func OptAuthManagerPostLoginRedirectHandler(handler AuthManagerRedirectHandler) AuthManagerOption

+ func OptAuthManagerRemoveHandler(handler AuthManagerRemoveHandler) AuthManagerOption

+ func OptAuthManagerSerializeSessionValueHandler(handler AuthManagerSerializeSessionValueHandler) AuthManagerOption

+ func OptAuthManagerSessionTimeoutProvider(handler AuthManagerSessionTimeoutProvider) AuthManagerOption

+ func OptAuthManagerValidateHandler(handler AuthManagerValidateHandler) AuthManagerOption

type CachedStaticFile

+ ETag string

type Config

+ CookieDomain string

+ CookieHTTPOnly *bool

+ CookieSameSite string

+ CookieSecure *bool

+ DisablePanicRecovery bool

+ KeepAlive *bool

+ KeepAlivePeriod time.Duration

+ SessionTimeoutIsRelative bool

+ SkipRedirectTrailingSlash bool

+ UseProxyProtocol bool

+ func (c *Config) Resolve(ctx context.Context) error

+ func (c Config) BaseURLOrDefault() string

+ func (c Config) BindAddrOrDefault(defaults ...string) string

+ func (c Config) CookieDomainOrDefault() string

+ func (c Config) CookieHTTPOnlyOrDefault() bool

+ func (c Config) CookieNameOrDefault() string

+ func (c Config) CookiePathOrDefault() string

+ func (c Config) CookieSameSiteOrDefault() http.SameSite

+ func (c Config) CookieSecureOrDefault() bool

+ func (c Config) IdleTimeoutOrDefault() time.Duration

+ func (c Config) KeepAliveOrDefault() bool

+ func (c Config) KeepAlivePeriodOrDefault() time.Duration

+ func (c Config) MaxHeaderBytesOrDefault() int

+ func (c Config) PortOrDefault() int32

+ func (c Config) ReadHeaderTimeoutOrDefault() time.Duration

+ func (c Config) ReadTimeoutOrDefault() time.Duration

+ func (c Config) SessionTimeoutOrDefault() time.Duration

+ func (c Config) ShutdownGracePeriodOrDefault() time.Duration

+ func (c Config) WriteTimeoutOrDefault() time.Duration

type Ctx

+ Body []byte

+ DefaultProvider ResultProvider

+ Form url.Values

+ Log logger.Log

+ RequestStarted time.Time

+ Views *ViewCache

+ func MockCtx(method, path string, options ...CtxOption) *Ctx

+ func (rc *Ctx) Annotations() map[string]interface{}

+ func (rc *Ctx) Close() error

+ func (rc *Ctx) Cookie(name string) *http.Cookie

+ func (rc *Ctx) CookieDomain() string

+ func (rc *Ctx) EnsureForm() error

+ func (rc *Ctx) Labels() map[string]string

+ func (rc *Ctx) PostBodyAsForm(response interface{}) error

+ type CtxOption func(*Ctx)

+ func CtxRequestOption(opt func(*http.Request) error) CtxOption

+ func OptCtxApp(a *App) CtxOption

+ func OptCtxAuth(auth AuthManager) CtxOption

+ func OptCtxBodyBytes(body []byte) CtxOption

+ func OptCtxCookieValue(key, value string) CtxOption

+ func OptCtxDefaultProvider(rp ResultProvider) CtxOption

+ func OptCtxHeaderValue(key, value string) CtxOption

+ func OptCtxLog(log logger.Log) CtxOption

+ func OptCtxPostFormValue(key, value string) CtxOption

+ func OptCtxPostedFiles(files ...webutil.PostedFile) CtxOption

+ func OptCtxQueryValue(key, value string) CtxOption

+ func OptCtxRequestStarted(ts time.Time) CtxOption

+ func OptCtxRoute(r *Route) CtxOption

+ func OptCtxRouteParamValue(key, value string) CtxOption

+ func OptCtxRouteParams(r RouteParameters) CtxOption

+ func OptCtxSession(s *Session) CtxOption

+ func OptCtxState(s State) CtxOption

+ func OptCtxTracer(tracer Tracer) CtxOption

+ func OptCtxViews(vc *ViewCache) CtxOption

type JSONResultProvider

+ func (jrp JSONResultProvider) Forbidden() Result

+ type LoggedErrorResult struct

+ Error error

+ Result Result

+ func ResultWithLoggedError(result Result, err error) *LoggedErrorResult

+ func (ler LoggedErrorResult) PostRender(ctx *Ctx) error

+ func (ler LoggedErrorResult) Render(ctx *Ctx) error

+ type MockResult struct

+ App *App

+ Server *httptest.Server

+ func Mock(app *App, req *http.Request, options ...r2.Option) *MockResult

+ func MockGet(app *App, path string, options ...r2.Option) *MockResult

+ func MockMethod(app *App, method, path string, options ...r2.Option) *MockResult

+ func MockPost(app *App, path string, body io.ReadCloser, options ...r2.Option) *MockResult

+ func (mr *MockResult) Close() error

+ type Option func(*App) error

+ func OptAuth(auth AuthManager, err error) Option

+ func OptBaseHeaders(headers http.Header) Option

+ func OptBaseMiddleware(middleware ...Middleware) Option

+ func OptBaseStateValue(key string, value interface{}) Option

+ func OptBindAddr(bindAddr string) Option

+ func OptConfig(cfg Config) Option

+ func OptConfigFromEnv() Option

+ func OptDefaultHeader(key, value string) Option

+ func OptDefaultHeaders(headers http.Header) Option

+ func OptDefaultMiddleware(middleware ...Middleware) Option

+ func OptLog(log logger.Log) Option

+ func OptMethodNotAllowedHandler(action Action) Option

+ func OptNotFoundHandler(action Action) Option

+ func OptPort(port int32) Option

+ func OptServer(server *http.Server) Option

+ func OptServerOptions(opts ...webutil.HTTPServerOption) Option

+ func OptShutdownGracePeriod(d time.Duration) Option

+ func OptTLSConfig(cfg *tls.Config) Option

+ func OptTracer(tracer Tracer) Option

+ func OptUse(m Middleware) Option

+ func OptViews(views *ViewCache) Option

type RawResult

+ func Raw(contents []byte) *RawResult

+ func RawWithContentType(contentType string, body []byte) *RawResult

type RedirectResult

+ func Redirect(destination string) *RedirectResult

+ func RedirectWithMethod(method, destination string) *RedirectResult

+ func RedirectWithMethodf(method, format string, args ...interface{}) *RedirectResult

+ func Redirectf(format string, args ...interface{}) *RedirectResult

+ type ResultPostRender interface

+ PostRender func(ctx *Ctx) error

+ type RouteNode struct

+ Children []*RouteNode

+ Indices string

+ IsWildcard bool

+ MaxParams uint8

+ Path string

+ Priority uint32

+ Route *Route

+ type RouteNodeType uint8

+ const RouteNodeTypeCatchAll

+ const RouteNodeTypeParam

+ const RouteNodeTypeRoot

+ const RouteNodeTypeStatic

type Session

+ func GetSession(ctx context.Context) *Session

type StaticFileServer

+ Cache map[string]*CachedStaticFile

+ CacheDisabled bool

+ SearchPaths []http.FileSystem

+ func (sc *StaticFileServer) ResolveCachedFile(filepath string) (*CachedStaticFile, error)

+ func (sc *StaticFileServer) ResolveFile(filePath string) (f http.File, finalPath string, err error)

+ func (sc *StaticFileServer) ServeCachedFile(r *Ctx, filepath string) Result

+ type StaticFileserverOption func(*StaticFileServer)

+ func OptStaticFileServerCacheDisabled(cacheDisabled bool) StaticFileserverOption

+ func OptStaticFileServerHeaders(headers http.Header) StaticFileserverOption

+ func OptStaticFileServerSearchPaths(searchPaths ...http.FileSystem) StaticFileserverOption

type StaticResult

+ func Static(filePath string) *StaticResult

+ type TLSOption func(*tls.Config) error

+ func OptTLSClientCertPool(certPEMs ...[]byte) TLSOption

+ func OptTLSClientCertVerification(verification tls.ClientAuthType) TLSOption

type ViewCache

+ BufferPool *bufferutil.Pool

+ LiveReload bool

+ func MustNewViewCache(opts ...ViewCacheOption) *ViewCache

type ViewCacheConfig

+ LiveReload bool

+ func (vcc *ViewCacheConfig) Resolve(ctx context.Context) error

+ func (vcc ViewCacheConfig) BadRequestTemplateNameOrDefault() string

+ func (vcc ViewCacheConfig) BufferPoolSizeOrDefault() int

+ func (vcc ViewCacheConfig) InternalErrorTemplateNameOrDefault() string

+ func (vcc ViewCacheConfig) NotAuthorizedTemplateNameOrDefault() string

+ func (vcc ViewCacheConfig) NotFoundTemplateNameOrDefault() string

+ func (vcc ViewCacheConfig) StatusTemplateNameOrDefault() string

+ type ViewCacheOption func(*ViewCache) error

+ func OptViewCacheBadRequestTemplateName(name string) ViewCacheOption

+ func OptViewCacheConfig(cfg *ViewCacheConfig) ViewCacheOption

+ func OptViewCacheFunc(name string, viewFunc interface{}) ViewCacheOption

+ func OptViewCacheFuncMap(funcMap template.FuncMap) ViewCacheOption

+ func OptViewCacheInternalErrorTemplateName(name string) ViewCacheOption

+ func OptViewCacheLiterals(literals ...string) ViewCacheOption

+ func OptViewCacheLiveReload(liveReload bool) ViewCacheOption

+ func OptViewCacheNotAuthorizedTemplateName(name string) ViewCacheOption

+ func OptViewCacheNotFoundTemplateName(name string) ViewCacheOption

+ func OptViewCachePaths(paths ...string) ViewCacheOption

+ func OptViewCacheStatusTemplateName(name string) ViewCacheOption

type ViewModel

+ Status ViewStatus

+ func (vm ViewModel) State(key string) interface{}

+ func (vm ViewModel) Wrap(other interface{}) ViewModel

+ type ViewStatus struct

+ Code int

+ Text string

type ViewTraceFinisher

+ FinishView func(*Ctx, *ViewResult, error)

v1.1.1

Feb 5, 2019

v1.1.0

Jan 10, 2019

Changes in this version

type AuthManager

+ func NewLocalAuthManagerFromCache(cache *LocalSessionCache) *AuthManager

v1.0.1

Jan 10, 2019

v1.0.0

Dec 5, 2018

Changes in this version

type ViewCache

+ func (vc *ViewCache) ViewStatus(statusCode int, viewName string, viewModel interface{}) Result

v1.0.0-rc3

Oct 3, 2018

v1.0.0-rc2

Sep 28, 2018

v1.0.0-rc1

Sep 12, 2018

v0

v0.3.5

Oct 31, 2018

v0.3.4

Oct 31, 2018

v0.3.3

Oct 31, 2018

v0.3.2

Oct 31, 2018

Changes in this version

+ func NewCtxID() string

v0.3.1

Oct 19, 2018

Changes in this version

type App

+ func (a *App) NotifyStopped() <-chan struct{}

+ func (a *App) Stop() error

type Healthz

+ func (hz *Healthz) NotifyStopped() <-chan struct{}

+ func (hz *Healthz) NotifyStopping() <-chan struct{}

+ func (hz *Healthz) Stop() error

+ type HealthzHostable interface

+ IsRunning func() bool

v0.3.0

Oct 17, 2018

v0.2.0

Oct 8, 2018

v0.1.0

Oct 5, 2018

Changes in this version

+ const AppExit

+ const AppStart

+ const AppStartComplete

+ const ConnectionKeepAlive

+ const ContentEncodingGZIP

+ const ContentEncodingIdentity

+ const ContentTypeApplicationJSON

+ const ContentTypeHTML

+ const ContentTypeText

+ const ContentTypeXML

+ const DefaultBindAddr

+ const DefaultCookieName

+ const DefaultCookiePath

+ const DefaultHSTS

+ const DefaultHSTSIncludeSubDomains

+ const DefaultHSTSMaxAgeSeconds

+ const DefaultHSTSPreload

+ const DefaultHTTPSUpgradeTargetPort

+ const DefaultHandleMethodNotAllowed

+ const DefaultHandleOptions

+ const DefaultHealthzBindAddr

+ const DefaultHealthzFailureThreshold

+ const DefaultIdleTimeout

+ const DefaultIntegrationBindAddr

+ const DefaultMaxHeaderBytes

+ const DefaultReadHeaderTimeout

+ const DefaultReadTimeout

+ const DefaultRecoverPanics

+ const DefaultRedirectTrailingSlash

+ const DefaultSecureCookieName

+ const DefaultSessionTimeout

+ const DefaultSessionTimeoutIsAbsolute

+ const DefaultShutdownGracePeriod

+ const DefaultTCPKeepAliveListenerPeriod

+ const DefaultTemplateBadRequest

+ const DefaultTemplateInternalError

+ const DefaultTemplateNameBadRequest

+ const DefaultTemplateNameInternalError

+ const DefaultTemplateNameNotAuthorized

+ const DefaultTemplateNameNotFound

+ const DefaultTemplateNameStatus

+ const DefaultTemplateNotAuthorized

+ const DefaultTemplateNotFound

+ const DefaultTemplateStatus

+ const DefaultUseSessionCache

+ const DefaultViewBufferPoolSize

+ const DefaultWriteTimeout

+ const EnvironmentVariableBindAddr

+ const EnvironmentVariableHealthzBindAddr

+ const EnvironmentVariableHealthzPort

+ const EnvironmentVariablePort

+ const EnvironmentVariableTLSCert

+ const EnvironmentVariableTLSCertFile

+ const EnvironmentVariableTLSKey

+ const EnvironmentVariableTLSKeyFile

+ const EnvironmentVariableUpgraderBindAddr

+ const EnvironmentVariableUpgraderPort

+ const ErrHealthzAppUnset

+ const ErrJWTNonstandardClaims

+ const ErrParameterMissing

+ const ErrSecureSessionIDEmpty

+ const ErrSessionIDEmpty

+ const ErrUnsetViewTemplate

+ const HSTSIncludeSubDomains

+ const HSTSMaxAgeFormat

+ const HSTSPreload

+ const HTTPSUpgraderExit

+ const HTTPSUpgraderStart

+ const HTTPSUpgraderStartComplete

+ const HeaderAcceptEncoding

+ const HeaderAllow

+ const HeaderCacheControl

+ const HeaderConnection

+ const HeaderContentEncoding

+ const HeaderContentLength

+ const HeaderContentType

+ const HeaderCookie

+ const HeaderDate

+ const HeaderServer

+ const HeaderSetCookie

+ const HeaderStrictTransportSecurity

+ const HeaderUserAgent

+ const HeaderVary

+ const HeaderXContentTypeOptions

+ const HeaderXFrameOptions

+ const HeaderXServedBy

+ const HeaderXXSSProtection

+ const HealthzExit

+ const HealthzStart

+ const HealthzStartComplete

+ const LenSessionID

+ const LenSessionIDBase64

+ const ListenerHealthz

+ const MethodConnect

+ const MethodDelete

+ const MethodGet

+ const MethodOptions

+ const MethodPost

+ const MethodPut

+ const PackageName

+ const PostBodySize

+ const PostBodySizeMax

+ const RegexpAssetCacheFiles

+ const RouteTokenFilepath

+ const SchemeHTTP

+ const SchemeHTTPS

+ const SchemeSPDY

+ const TestTLSCert

+ const TestTLSKey

+ var DefaultHeaders = map[string]string

+ var GracefulShutdown = StartWithGracefulShutdown

+ func Base64URLDecode(raw string) ([]byte, error)

+ func Base64URLEncode(raw []byte) string

+ func BoolValue(value string, inputErr error) (output bool, err error)

+ func CSVValue(value string, err error) ([]string, error)

+ func CleanPath(p string) string

+ func DurationValue(value string, inputErr error) (output time.Duration, err error)

+ func Float64Value(value string, inputErr error) (output float64, err error)

+ func Int64Value(value string, inputErr error) (output int64, err error)

+ func IntValue(value string, inputErr error) (output int, err error)

+ func IsErrSessionInvalid(err error) bool

+ func NewAppEventListener(listener func(me *AppEvent)) logger.Listener

+ func NewCookie(name, value string) *http.Cookie

+ func NewSessionID() string

+ func ParseInt32(v string) int32

+ func PathRedirectHandler(path string) func(*Ctx) *url.URL

+ func ReadSetCookies(h http.Header) []*http.Cookie

+ func ResultOrDefault(defaultResult interface{}, result ...interface{}) interface

+ func SessionTimeoutProvider(isAbsolute bool, timeout time.Duration) func(*Session) time.Time

+ func SessionTimeoutProviderAbsolute(timeout time.Duration) func(*Session) time.Time

+ func SessionTimeoutProviderRolling(timeout time.Duration) func(*Session) time.Time

+ func StartWithGracefulShutdown(app Shutdowner) error

+ func StringValue(value string, _ error) string

+ func ViewFuncs() template.FuncMap

+ type Action func(*Ctx) Result

+ func JSONProviderAsDefault(action Action) Action

+ func NestMiddleware(action Action, middleware ...Middleware) Action

+ func SessionAware(action Action) Action

+ func SessionRequired(action Action) Action

+ func TextProviderAsDefault(action Action) Action

+ func ViewProviderAsDefault(action Action) Action

+ func XMLProviderAsDefault(action Action) Action

+ type Any = interface

+ type App struct

+ func MustNewFromEnv() *App

+ func New() *App

+ func NewFromConfig(cfg *Config) *App

+ func NewFromEnv() (*App, error)

+ func (a *App) Auth() *AuthManager

+ func (a *App) BaseURL() *url.URL

+ func (a *App) BindAddr() string

+ func (a *App) Config() *Config

+ func (a *App) CreateServer() *http.Server

+ func (a *App) DELETE(path string, action Action, middleware ...Middleware)

+ func (a *App) DefaultHeaders() map[string]string

+ func (a *App) DefaultMiddleware() []Middleware

+ func (a *App) DefaultResultProvider() ResultProvider

+ func (a *App) GET(path string, action Action, middleware ...Middleware)

+ func (a *App) HEAD(path string, action Action, middleware ...Middleware)

+ func (a *App) HSTS() *HSTSConfig

+ func (a *App) Handle(method, path string, handler Handler)

+ func (a *App) HandleMethodNotAllowed() bool

+ func (a *App) HandleOptions() bool

+ func (a *App) Handler() http.Handler

+ func (a *App) IdleTimeout() time.Duration

+ func (a *App) IsRunning() bool

+ func (a *App) Latch() *async.Latch

+ func (a *App) Listener() *net.TCPListener

+ func (a *App) Logger() *logger.Logger

+ func (a *App) Lookup(method, path string) (route *Route, params RouteParameters, slashRedirect bool)

+ func (a *App) MaxHeaderBytes() int

+ func (a *App) MethodNotAllowedHandler() Handler

+ func (a *App) Mock() *MockRequestBuilder

+ func (a *App) NotFoundHandler() Handler

+ func (a *App) NotifyShutdown() <-chan struct{}

+ func (a *App) NotifyStarted() <-chan struct{}

+ func (a *App) OPTIONS(path string, action Action, middleware ...Middleware)

+ func (a *App) PATCH(path string, action Action, middleware ...Middleware)

+ func (a *App) POST(path string, action Action, middleware ...Middleware)

+ func (a *App) PUT(path string, action Action, middleware ...Middleware)

+ func (a *App) PanicAction() PanicAction

+ func (a *App) ReadHeaderTimeout() time.Duration

+ func (a *App) ReadTimeout() time.Duration

+ func (a *App) RecoverPanics() bool

+ func (a *App) RedirectTrailingSlash() bool

+ func (a *App) Register(c Controller)

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

+ func (a *App) ServeStatic(route, filepath string)

+ func (a *App) ServeStaticCached(route, filepath string)

+ func (a *App) Server() *http.Server

+ func (a *App) SetStaticHeader(route, key, value string) error

+ func (a *App) SetStaticMiddleware(route string, middlewares ...Middleware) error

+ func (a *App) SetStaticRewriteRule(route, match string, action RewriteAction) error

+ func (a *App) SetTLSClientCertPool(certs ...[]byte) error

+ func (a *App) Shutdown() error

+ func (a *App) ShutdownGracePeriod() time.Duration

+ func (a *App) Start() (err error)

+ func (a *App) StartupTasks() error

+ func (a *App) State() State

+ func (a *App) StateValue(key string) interface{}

+ func (a *App) TLSConfig() *tls.Config

+ func (a *App) Tracer() Tracer

+ func (a *App) Views() *ViewCache

+ func (a *App) WithAuth(am *AuthManager) *App

+ func (a *App) WithBaseURL(baseURL *url.URL) *App

+ func (a *App) WithBindAddr(bindAddr string) *App

+ func (a *App) WithConfig(cfg *Config) *App

+ func (a *App) WithControllers(controllers ...Controller) *App

+ func (a *App) WithDefaultHeader(key string, value string) *App

+ func (a *App) WithDefaultHeaders(headers map[string]string) *App

+ func (a *App) WithDefaultMiddleware(middleware ...Middleware) *App

+ func (a *App) WithDefaultMiddlewares(middleware ...Middleware) *App

+ func (a *App) WithDefaultResultProvider(drp ResultProvider) *App

+ func (a *App) WithHSTS(hsts *HSTSConfig) *App

+ func (a *App) WithHandleMethodNotAllowed(handle bool) *App

+ func (a *App) WithHandleOptions(handle bool) *App

+ func (a *App) WithHandler(handler http.Handler) *App

+ func (a *App) WithIdleTimeout(timeout time.Duration) *App

+ func (a *App) WithLogger(log *logger.Logger) *App

+ func (a *App) WithMaxHeaderBytes(byteCount int) *App

+ func (a *App) WithMethodNotAllowedHandler(handler Action) *App

+ func (a *App) WithNotFoundHandler(handler Action) *App

+ func (a *App) WithPanicAction(action PanicAction) *App

+ func (a *App) WithPort(port int32) *App

+ func (a *App) WithReadHeaderTimeout(timeout time.Duration) *App

+ func (a *App) WithReadTimeout(timeout time.Duration) *App

+ func (a *App) WithRecoverPanics(value bool) *App

+ func (a *App) WithRedirectTrailingSlash(value bool) *App

+ func (a *App) WithServer(server *http.Server) *App

+ func (a *App) WithShutdownGracePeriod(gracePeriod time.Duration) *App

+ func (a *App) WithStateValue(key string, value interface{}) *App

+ func (a *App) WithTLSClientCertVerification(verification tls.ClientAuthType) *App

+ func (a *App) WithTLSConfig(config *tls.Config) *App

+ func (a *App) WithTracer(tracer Tracer) *App

+ func (a *App) WithViews(vc *ViewCache) *App

+ func (a *App) WithWriteTimeout(timeout time.Duration) *App

+ func (a *App) WriteTimeout() time.Duration

+ type AppEvent struct

+ func NewAppEvent(flag logger.Flag) *AppEvent

+ func (ae *AppEvent) Elapsed() time.Duration

+ func (ae *AppEvent) Err() error

+ func (ae *AppEvent) WithAnnotation(key, value string) *AppEvent

+ func (ae *AppEvent) WithApp(app *App) *AppEvent

+ func (ae *AppEvent) WithElapsed(elapsed time.Duration) *AppEvent

+ func (ae *AppEvent) WithErr(err error) *AppEvent

+ func (ae *AppEvent) WithFlag(flag logger.Flag) *AppEvent

+ func (ae *AppEvent) WithHeadings(headings ...string) *AppEvent

+ func (ae *AppEvent) WithHealthz(hz *Healthz) *AppEvent

+ func (ae *AppEvent) WithLabel(key, value string) *AppEvent

+ func (ae *AppEvent) WithTimestamp(ts time.Time) *AppEvent

+ func (ae *AppEvent) WithUpgrader(upgrader *HTTPSUpgrader) *AppEvent

+ func (ae *AppEvent) WriteJSON() logger.JSONObj

+ func (ae *AppEvent) WriteText(tf logger.TextFormatter, buf *bytes.Buffer)

+ func (ae AppEvent) App() *App

+ func (ae AppEvent) Healthz() *Healthz

+ func (ae AppEvent) Upgrader() *HTTPSUpgrader

+ type AuthManager struct

+ func NewAuthManagerFromConfig(cfg *Config) (manager *AuthManager)

+ func NewJWTAuthManager(key []byte) *AuthManager

+ func NewLocalAuthManager() *AuthManager

+ func NewServerAuthManager() *AuthManager

+ func (am *AuthManager) CookieName() string

+ func (am *AuthManager) CookiePath() string

+ func (am *AuthManager) CookiesHTTPSOnly() bool

+ func (am *AuthManager) FetchHandler() AuthManagerFetchHandler

+ func (am *AuthManager) Login(userID string, ctx *Ctx) (session *Session, err error)

+ func (am *AuthManager) LoginRedirect(ctx *Ctx) Result

+ func (am *AuthManager) LoginRedirectHandler() AuthManagerRedirectHandler

+ func (am *AuthManager) Logout(ctx *Ctx) error

+ func (am *AuthManager) ParseSessionValueHandler() AuthManagerParseSessionValueHandler

+ func (am *AuthManager) PersistHandler() AuthManagerPersistHandler

+ func (am *AuthManager) PostLoginRedirect(ctx *Ctx) Result

+ func (am *AuthManager) PostLoginRedirectHandler() AuthManagerRedirectHandler

+ func (am *AuthManager) RemoveHandler() AuthManagerRemoveHandler

+ func (am *AuthManager) SerializeSessionValueHandler() AuthManagerSerializeSessionValueHandler

+ func (am *AuthManager) SessionTimeoutProvider() func(*Session) time.Time

+ func (am *AuthManager) ValidateHandler() AuthManagerValidateHandler

+ func (am *AuthManager) VerifySession(ctx *Ctx) (session *Session, err error)

+ func (am *AuthManager) WithCookieHTTPSOnly(isHTTPSOnly bool) *AuthManager

+ func (am *AuthManager) WithCookieName(paramName string) *AuthManager

+ func (am *AuthManager) WithCookiePath(path string) *AuthManager

+ func (am *AuthManager) WithFetchHandler(handler AuthManagerFetchHandler) *AuthManager

+ func (am *AuthManager) WithLoginRedirectHandler(handler AuthManagerRedirectHandler) *AuthManager

+ func (am *AuthManager) WithParseSessionValueHandler(handler AuthManagerParseSessionValueHandler) *AuthManager

+ func (am *AuthManager) WithPersistHandler(handler AuthManagerPersistHandler) *AuthManager

+ func (am *AuthManager) WithPostLoginRedirectHandler(handler AuthManagerRedirectHandler) *AuthManager

+ func (am *AuthManager) WithRemoveHandler(handler AuthManagerRemoveHandler) *AuthManager

+ func (am *AuthManager) WithSerializeSessionValueHandler(handler AuthManagerSerializeSessionValueHandler) *AuthManager

+ func (am *AuthManager) WithSessionTimeoutProvider(timeoutProvider func(*Session) time.Time) *AuthManager

+ func (am *AuthManager) WithValidateHandler(handler AuthManagerValidateHandler) *AuthManager

+ type AuthManagerFetchHandler func(context.Context, string, State) (*Session, error)

+ type AuthManagerMode string

+ const AuthManagerModeJWT

+ const AuthManagerModeLocal

+ const AuthManagerModeServer

+ type AuthManagerParseSessionValueHandler func(context.Context, string, State) (*Session, error)

+ type AuthManagerPersistHandler func(context.Context, *Session, State) error

+ type AuthManagerRedirectHandler func(*Ctx) *url.URL

+ type AuthManagerRemoveHandler func(context.Context, string, State) error

+ type AuthManagerSerializeSessionValueHandler func(context.Context, *Session, State) (string, error)

+ type AuthManagerSessionTimeoutProvider func(*Session) time.Time

+ type AuthManagerValidateHandler func(context.Context, *Session, State) error

+ type BufferPool struct

+ func NewBufferPool(bufferSize int) *BufferPool

+ func (bp *BufferPool) Get() *bytes.Buffer

+ func (bp *BufferPool) Put(b *bytes.Buffer)

+ type CachedStaticFile struct

+ Contents *bytes.Reader

+ ModTime time.Time

+ Path string

+ Size int

+ func (csf CachedStaticFile) Render(ctx *Ctx) error

+ type CachedStaticFileServer struct

+ func NewCachedStaticFileServer(fs http.FileSystem) *CachedStaticFileServer

+ func (csfs *CachedStaticFileServer) Action(r *Ctx) Result

+ func (csfs *CachedStaticFileServer) AddHeader(key, value string)

+ func (csfs *CachedStaticFileServer) AddRewriteRule(match string, action RewriteAction) error

+ func (csfs *CachedStaticFileServer) Files() map[string]*CachedStaticFile

+ func (csfs *CachedStaticFileServer) GetCachedFile(filepath string) (*CachedStaticFile, error)

+ func (csfs *CachedStaticFileServer) Headers() http.Header

+ func (csfs *CachedStaticFileServer) Log() *logger.Logger

+ func (csfs *CachedStaticFileServer) RewriteRules() []RewriteRule

+ func (csfs *CachedStaticFileServer) ServeFile(r *Ctx) Result

+ func (csfs *CachedStaticFileServer) SetMiddleware(middlewares ...Middleware)

+ func (csfs *CachedStaticFileServer) WithLogger(log *logger.Logger) *CachedStaticFileServer

+ type CompressedResponseWriter struct

+ func NewCompressedResponseWriter(w http.ResponseWriter) *CompressedResponseWriter

+ func (crw *CompressedResponseWriter) Close() error

+ func (crw *CompressedResponseWriter) ContentLength() int

+ func (crw *CompressedResponseWriter) Flush() error

+ func (crw *CompressedResponseWriter) Header() http.Header

+ func (crw *CompressedResponseWriter) InnerResponse() http.ResponseWriter

+ func (crw *CompressedResponseWriter) StatusCode() int

+ func (crw *CompressedResponseWriter) Write(b []byte) (int, error)

+ func (crw *CompressedResponseWriter) WriteHeader(code int)

+ type Config struct

+ AuthManagerMode string

+ AuthSecret string

+ BaseURL string

+ BindAddr string

+ CookieHTTPSOnly *bool

+ CookieName string

+ CookiePath string

+ DefaultHeaders map[string]string

+ HSTS HSTSConfig

+ HandleMethodNotAllowed *bool

+ HandleOptions *bool

+ Healthz HealthzConfig

+ IdleTimeout time.Duration

+ MaxHeaderBytes int

+ Port int32

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ RecoverPanics *bool

+ RedirectTrailingSlash *bool

+ SessionTimeout time.Duration

+ SessionTimeoutIsAbsolute *bool

+ ShutdownGracePeriod time.Duration

+ TLS TLSConfig

+ Views ViewCacheConfig

+ WriteTimeout time.Duration

+ func MustNewConfigFromEnv() *Config

+ func NewConfigFromEnv() (*Config, error)

+ func (c Config) BaseURLIsSecureScheme() bool

+ func (c Config) GetAuthManagerMode(inherited ...string) AuthManagerMode

+ func (c Config) GetAuthSecret(defaults ...[]byte) []byte

+ func (c Config) GetBaseURL(defaults ...string) string

+ func (c Config) GetBindAddr(defaults ...string) string

+ func (c Config) GetCookieHTTPSOnly(defaults ...bool) bool

+ func (c Config) GetCookieName(defaults ...string) string

+ func (c Config) GetCookiePath(defaults ...string) string

+ func (c Config) GetDefaultHeaders(inherited ...map[string]string) map[string]string

+ func (c Config) GetHandleMethodNotAllowed(defaults ...bool) bool

+ func (c Config) GetHandleOptions(defaults ...bool) bool

+ func (c Config) GetIdleTimeout(defaults ...time.Duration) time.Duration

+ func (c Config) GetMaxHeaderBytes(defaults ...int) int

+ func (c Config) GetPort(defaults ...int32) int32

+ func (c Config) GetReadHeaderTimeout(defaults ...time.Duration) time.Duration

+ func (c Config) GetReadTimeout(defaults ...time.Duration) time.Duration

+ func (c Config) GetRecoverPanics(defaults ...bool) bool

+ func (c Config) GetRedirectTrailingSlash(defaults ...bool) bool

+ func (c Config) GetSessionTimeout(defaults ...time.Duration) time.Duration

+ func (c Config) GetSessionTimeoutIsAbsolute(defaults ...bool) bool

+ func (c Config) GetShutdownGracePeriod(defaults ...time.Duration) time.Duration

+ func (c Config) GetWriteTimeout(defaults ...time.Duration) time.Duration

+ func (c Config) IsSecure() bool

+ func (c Config) ListenTLS() bool

+ type Controller interface

+ Register func(app *App)

+ type Ctx struct

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

+ func NewMockCtx(method, path string) *Ctx

+ func (rc *Ctx) App() *App

+ func (rc *Ctx) Auth() *AuthManager

+ func (rc *Ctx) Context() context.Context

+ func (rc *Ctx) DefaultResultProvider() ResultProvider

+ func (rc *Ctx) Elapsed() time.Duration

+ func (rc *Ctx) ExpireCookie(name string, path string)

+ func (rc *Ctx) ExtendCookie(name string, path string, years, months, days int)

+ func (rc *Ctx) ExtendCookieByDuration(name string, path string, duration time.Duration)

+ func (rc *Ctx) FormValue(key string) (output string, err error)

+ func (rc *Ctx) GetCookie(name string) *http.Cookie

+ func (rc *Ctx) HeaderValue(key string) (value string, err error)

+ func (rc *Ctx) ID() string

+ func (rc *Ctx) JSON() JSONResultProvider

+ func (rc *Ctx) Logger() *logger.Logger

+ func (rc *Ctx) NoContent() NoContentResult

+ func (rc *Ctx) Param(name string) (string, error)

+ func (rc *Ctx) PostBody() ([]byte, error)

+ func (rc *Ctx) PostBodyAsJSON(response interface{}) error

+ func (rc *Ctx) PostBodyAsString() (string, error)

+ func (rc *Ctx) PostBodyAsXML(response interface{}) error

+ func (rc *Ctx) PostedFiles() ([]PostedFile, error)

+ func (rc *Ctx) QueryValue(key string) (value string, err error)

+ func (rc *Ctx) Raw(body []byte) *RawResult

+ func (rc *Ctx) RawWithContentType(contentType string, body []byte) *RawResult

+ func (rc *Ctx) Redirect(destination string) *RedirectResult

+ func (rc *Ctx) RedirectWithMethod(method, destination string) *RedirectResult

+ func (rc *Ctx) RedirectWithMethodf(method, format string, args ...interface{}) *RedirectResult

+ func (rc *Ctx) Redirectf(format string, args ...interface{}) *RedirectResult

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

+ func (rc *Ctx) Response() ResponseWriter

+ func (rc *Ctx) Route() *Route

+ func (rc *Ctx) RouteParam(key string) (output string, err error)

+ func (rc *Ctx) RouteParams() RouteParameters

+ func (rc *Ctx) Session() *Session

+ func (rc *Ctx) State() State

+ func (rc *Ctx) StateValue(key string) interface{}

+ func (rc *Ctx) Static(filePath string) *StaticResult

+ func (rc *Ctx) Text() TextResultProvider

+ func (rc *Ctx) Tracer() Tracer

+ func (rc *Ctx) View() *ViewCache

+ func (rc *Ctx) WithApp(app *App) *Ctx

+ func (rc *Ctx) WithAuth(authManager *AuthManager) *Ctx

+ func (rc *Ctx) WithContext(context context.Context) *Ctx

+ func (rc *Ctx) WithDefaultResultProvider(provider ResultProvider) *Ctx

+ func (rc *Ctx) WithID(id string) *Ctx

+ func (rc *Ctx) WithLogger(log *logger.Logger) *Ctx

+ func (rc *Ctx) WithRequest(req *http.Request) *Ctx

+ func (rc *Ctx) WithResponse(res ResponseWriter) *Ctx

+ func (rc *Ctx) WithRoute(route *Route) *Ctx

+ func (rc *Ctx) WithRouteParams(params RouteParameters) *Ctx

+ func (rc *Ctx) WithSession(session *Session) *Ctx

+ func (rc *Ctx) WithState(state State) *Ctx

+ func (rc *Ctx) WithStateValue(key string, value interface{}) *Ctx

+ func (rc *Ctx) WithTracer(tracer Tracer) *Ctx

+ func (rc *Ctx) WithViews(vc *ViewCache) *Ctx

+ func (rc *Ctx) WriteCookie(cookie *http.Cookie)

+ func (rc *Ctx) WriteNewCookie(name string, value string, expires time.Time, path string, secure bool)

+ func (rc *Ctx) XML() XMLResultProvider

+ func (rc Ctx) End() time.Time

+ func (rc Ctx) Start() time.Time

+ type Fileserver interface

+ Action func(*Ctx) Result

+ AddHeader func(key, value string)

+ AddRewriteRule func(match string, rewriteAction RewriteAction) error

+ Headers func() http.Header

+ RewriteRules func() []RewriteRule

+ SetMiddleware func(middleware ...Middleware)

+ type HSTSConfig struct

+ Enabled *bool

+ IncludeSubDomains *bool

+ MaxAgeSeconds int

+ Preload *bool

+ func (h HSTSConfig) GetEnabled(defaults ...bool) bool

+ func (h HSTSConfig) GetIncludeSubDomains(defaults ...bool) bool

+ func (h HSTSConfig) GetMaxAgeSeconds(defaults ...int) int

+ func (h HSTSConfig) GetPreload(defaults ...bool) bool

+ type HTTPSUpgrader struct

+ func NewHTTPSUpgrader() *HTTPSUpgrader

+ func NewHTTPSUpgraderFromConfig(cfg *HTTPSUpgraderConfig) *HTTPSUpgrader

+ func NewHTTPSUpgraderFromEnv() *HTTPSUpgrader

+ func (hu *HTTPSUpgrader) Logger() *logger.Logger

+ func (hu *HTTPSUpgrader) ServeHTTP(rw http.ResponseWriter, req *http.Request)

+ func (hu *HTTPSUpgrader) TargetPort() int32

+ func (hu *HTTPSUpgrader) WithLogger(log *logger.Logger) *HTTPSUpgrader

+ func (hu *HTTPSUpgrader) WithTargetPort(targetPort int32) *HTTPSUpgrader

+ type HTTPSUpgraderConfig struct

+ TargetPort int32

+ func NewHTTPSUpgraderConfigFromEnv() *HTTPSUpgraderConfig

+ func (c HTTPSUpgraderConfig) GetTargetPort(defaults ...int32) int32

+ type Handler func(http.ResponseWriter, *http.Request, *Route, RouteParameters)

+ func WrapHandler(handler http.Handler) Handler

+ type Healthz struct

+ func NewHealthz(hosted Shutdowner) *Healthz

+ func (hz *Healthz) BindAddr() string

+ func (hz *Healthz) Config() *HealthzConfig

+ func (hz *Healthz) DefaultHeaders() map[string]string

+ func (hz *Healthz) FailureThreshold() int

+ func (hz *Healthz) GracePeriod() time.Duration

+ func (hz *Healthz) Hosted() Shutdowner

+ func (hz *Healthz) IdleTimeout() time.Duration

+ func (hz *Healthz) IsRunning() bool

+ func (hz *Healthz) Logger() *logger.Logger

+ func (hz *Healthz) MaxHeaderBytes() int

+ func (hz *Healthz) NotifyShutdown() <-chan struct{}

+ func (hz *Healthz) NotifyShuttingDown() <-chan struct{}

+ func (hz *Healthz) NotifyStarted() <-chan struct{}

+ func (hz *Healthz) ReadHeaderTimeout() time.Duration

+ func (hz *Healthz) ReadTimeout() time.Duration

+ func (hz *Healthz) RecoverPanics() bool

+ func (hz *Healthz) Self() *App

+ func (hz *Healthz) ServeHTTP(w http.ResponseWriter, r *http.Request)

+ func (hz *Healthz) Shutdown() error

+ func (hz *Healthz) Start() error

+ func (hz *Healthz) WithBindAddr(bindAddr string) *Healthz

+ func (hz *Healthz) WithConfig(cfg *HealthzConfig) *Healthz

+ func (hz *Healthz) WithDefaultHeader(key, value string) *Healthz

+ func (hz *Healthz) WithFailureThreshold(failureThreshold int) *Healthz

+ func (hz *Healthz) WithGracePeriod(gracePeriod time.Duration) *Healthz

+ func (hz *Healthz) WithIdleTimeout(timeout time.Duration) *Healthz

+ func (hz *Healthz) WithLogger(log *logger.Logger) *Healthz

+ func (hz *Healthz) WithMaxHeaderBytes(byteCount int) *Healthz

+ func (hz *Healthz) WithReadHeaderTimeout(timeout time.Duration) *Healthz

+ func (hz *Healthz) WithReadTimeout(timeout time.Duration) *Healthz

+ func (hz *Healthz) WithRecoverPanics(value bool) *Healthz

+ func (hz *Healthz) WithWriteTimeout(timeout time.Duration) *Healthz

+ func (hz *Healthz) WriteTimeout() time.Duration

+ type HealthzConfig struct

+ BindAddr string

+ FailureThreshold int

+ GracePeriod time.Duration

+ IdleTimeout time.Duration

+ MaxHeaderBytes int

+ ReadHeaderTimeout time.Duration

+ ReadTimeout time.Duration

+ RecoverPanics *bool

+ WriteTimeout time.Duration

+ func (hzc HealthzConfig) GetBindAddr(defaults ...string) string

+ func (hzc HealthzConfig) GetFailureThreshold(defaults ...int) int

+ func (hzc HealthzConfig) GetGracePeriod(defaults ...time.Duration) time.Duration

+ func (hzc HealthzConfig) GetIdleTimeout(defaults ...time.Duration) time.Duration

+ func (hzc HealthzConfig) GetMaxHeaderBytes(defaults ...int) int

+ func (hzc HealthzConfig) GetReadHeaderTimeout(defaults ...time.Duration) time.Duration

+ func (hzc HealthzConfig) GetReadTimeout(defaults ...time.Duration) time.Duration

+ func (hzc HealthzConfig) GetRecoverPanics(defaults ...bool) bool

+ func (hzc HealthzConfig) GetWriteTimeout(defaults ...time.Duration) time.Duration

+ type JSONResult struct

+ Response interface{}

+ StatusCode int

+ func (jr *JSONResult) Render(ctx *Ctx) error

+ type JSONResultProvider struct

+ var JSON JSONResultProvider

+ func (jrp JSONResultProvider) BadRequest(err error) Result

+ func (jrp JSONResultProvider) InternalError(err error) Result

+ func (jrp JSONResultProvider) NotAuthorized() Result

+ func (jrp JSONResultProvider) NotFound() Result

+ func (jrp JSONResultProvider) OK() Result

+ func (jrp JSONResultProvider) Result(response interface{}) Result

+ func (jrp JSONResultProvider) Status(statusCode int, response ...interface{}) Result

+ type JWTManager struct

+ KeyProvider func(*Session) ([]byte, error)

+ func NewJWTManager(key []byte) *JWTManager

+ func (jwtm JWTManager) Claims(session *Session) *jwt.StandardClaims

+ func (jwtm JWTManager) FromClaims(claims *jwt.StandardClaims) *Session

+ func (jwtm JWTManager) KeyFunc(token *jwt.Token) (interface{}, error)

+ func (jwtm JWTManager) ParseSessionValueHandler(_ context.Context, sessionValue string, _ State) (*Session, error)

+ func (jwtm JWTManager) SerializeSessionValueHandler(_ context.Context, session *Session, _ State) (output string, err error)

+ type LocalSessionCache struct

+ SessionLock *sync.Mutex

+ Sessions map[string]*Session

+ func NewLocalSessionCache() *LocalSessionCache

+ func (lsc *LocalSessionCache) FetchHandler(_ context.Context, sessionID string, _ State) (*Session, error)

+ func (lsc *LocalSessionCache) Get(sessionID string) *Session

+ func (lsc *LocalSessionCache) PersistHandler(_ context.Context, session *Session, _ State) error

+ func (lsc *LocalSessionCache) Remove(sessionID string)

+ func (lsc *LocalSessionCache) RemoveHandler(_ context.Context, sessionID string, _ State) error

+ func (lsc *LocalSessionCache) Upsert(session *Session)

+ type Middleware func(Action) Action

+ func SessionMiddleware(notAuthorized Action) Middleware

+ func WithTimeout(d time.Duration) Middleware

+ type MockRequestBuilder struct

+ func NewMockRequestBuilder(app *App) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) Bytes() ([]byte, error)

+ func (mrb *MockRequestBuilder) BytesWithMeta() ([]byte, *ResponseMeta, error)

+ func (mrb *MockRequestBuilder) CreateCtx(p RouteParameters) (*Ctx, error)

+ func (mrb *MockRequestBuilder) Delete(pathFormat string, args ...interface{}) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) Err() error

+ func (mrb *MockRequestBuilder) Execute() error

+ func (mrb *MockRequestBuilder) ExecuteWithMeta() (*ResponseMeta, error)

+ func (mrb *MockRequestBuilder) Get(pathFormat string, args ...interface{}) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) GetStateValue(key string) interface{}

+ func (mrb *MockRequestBuilder) JSON(object interface{}) error

+ func (mrb *MockRequestBuilder) JSONWithMeta(object interface{}) (*ResponseMeta, error)

+ func (mrb *MockRequestBuilder) LookupRoute() (route *Route, params RouteParameters)

+ func (mrb *MockRequestBuilder) Patch(pathFormat string, args ...interface{}) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) Post(pathFormat string, args ...interface{}) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) Put(pathFormat string, args ...interface{}) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) Request() (*http.Request, error)

+ func (mrb *MockRequestBuilder) Response() (res *http.Response, err error)

+ func (mrb *MockRequestBuilder) State() State

+ func (mrb *MockRequestBuilder) WithBasicAuth(username, password string) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithCookie(cookie *http.Cookie) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithCookieValue(name, value string) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithErr(err error) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithFormValue(key, value string) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithHeader(key, value string) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithPathf(pathFormat string, args ...interface{}) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithPostBody(postBody []byte) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithPostBodyAsJSON(object interface{}) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithPostedFile(postedFile PostedFile) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithQueryString(key, value string) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithStateValue(key string, value interface{}) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) WithVerb(verb string) *MockRequestBuilder

+ func (mrb *MockRequestBuilder) XML(object interface{}) error

+ func (mrb *MockRequestBuilder) XMLWithMeta(object interface{}) (*ResponseMeta, error)

+ type NoContentResult struct

+ var NoContent NoContentResult

+ func (ncr NoContentResult) Render(ctx *Ctx) error

+ type PanicAction func(*Ctx, interface{}) Result

+ type PanicHandler func(http.ResponseWriter, *http.Request, interface{})

+ type PostedFile struct

+ Contents []byte

+ FileName string

+ Key string

+ type RawResponseWriter struct

+ func NewRawResponseWriter(w http.ResponseWriter) *RawResponseWriter

+ func (rw *RawResponseWriter) Close() error

+ func (rw *RawResponseWriter) ContentLength() int

+ func (rw *RawResponseWriter) Header() http.Header

+ func (rw *RawResponseWriter) InnerResponse() http.ResponseWriter

+ func (rw *RawResponseWriter) StatusCode() int

+ func (rw *RawResponseWriter) Write(b []byte) (int, error)

+ func (rw *RawResponseWriter) WriteHeader(code int)

+ type RawResult struct

+ ContentType string

+ Response []byte

+ StatusCode int

+ func (rr *RawResult) Render(ctx *Ctx) error

+ type RedirectResult struct

+ Method string

+ RedirectURI string

+ func (rr *RedirectResult) Render(ctx *Ctx) error

+ type RequestMeta struct

+ Body []byte

+ Headers http.Header

+ StartTime time.Time

+ URL *url.URL

+ Verb string

+ func NewRequestMeta(req *http.Request) *RequestMeta

+ func NewRequestMetaWithBody(req *http.Request) (*RequestMeta, error)

+ type ResponseMeta struct

+ ContentLength int64

+ Headers http.Header

+ StatusCode int

+ func NewResponseMeta(res *http.Response) *ResponseMeta

+ type ResponseWriter interface

+ Close func() error

+ ContentLength func() int

+ Header func() http.Header

+ InnerResponse func() http.ResponseWriter

+ StatusCode func() int

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

+ WriteHeader func(int)

+ type Result interface

+ Render func(ctx *Ctx) error

+ type ResultPreRender interface

+ PreRender func(ctx *Ctx) error

+ type ResultProvider interface

+ BadRequest func(err error) Result

+ InternalError func(err error) Result

+ NotAuthorized func() Result

+ NotFound func() Result

+ Status func(statusCode int, result ...interface{}) Result

+ type ResultRenderComplete interface

+ RenderComplete func(ctx *Ctx) error

+ type RewriteAction func(filePath string, matchedPieces ...string) string

+ type RewriteRule struct

+ Action RewriteAction

+ MatchExpression string

+ func (rr RewriteRule) Apply(filePath string) (bool, string)

+ type Route struct

+ Method string

+ Params []string

+ Path string

+ func (r Route) String() string

+ func (r Route) StringWithMethod() string

+ type RouteParameters map[string]string

+ func (rp RouteParameters) Get(key string) string

+ func (rp RouteParameters) Has(key string) bool

+ func (rp RouteParameters) Set(key, value string)

+ type Session struct

+ BaseURL string

+ CreatedUTC time.Time

+ ExpiresUTC time.Time

+ RemoteAddr string

+ SessionID string

+ State map[string]interface{}

+ UserAgent string

+ UserID string

+ func NewSession(userID string, sessionID string) *Session

+ func (s *Session) IsExpired() bool

+ func (s *Session) IsZero() bool

+ func (s *Session) WithBaseURL(baseURL string) *Session

+ func (s *Session) WithRemoteAddr(remoteAddr string) *Session

+ func (s *Session) WithUserAgent(userAgent string) *Session

+ type SessionLockPolicy int

+ const SessionReadLock

+ const SessionReadWriteLock

+ const SessionUnsafe

+ type Shutdowner interface

+ IsRunning func() bool

+ NotifyShutdown func() <-chan struct{}

+ NotifyStarted func() <-chan struct{}

+ Shutdown func() error

+ Start func() error

+ type State interface

+ Copy func() State

+ Get func(key string) Any

+ Keys func() []string

+ Remove func(key string)

+ Set func(key string, value Any)

+ type StaticFileServer struct

+ func NewStaticFileServer(fs http.FileSystem) *StaticFileServer

+ func (sc *StaticFileServer) Action(r *Ctx) Result

+ func (sc *StaticFileServer) AddHeader(key, value string)

+ func (sc *StaticFileServer) AddRewriteRule(match string, action RewriteAction) error

+ func (sc *StaticFileServer) Headers() http.Header

+ func (sc *StaticFileServer) Log() *logger.Logger

+ func (sc *StaticFileServer) RewriteRules() []RewriteRule

+ func (sc *StaticFileServer) ServeFile(r *Ctx) Result

+ func (sc *StaticFileServer) SetMiddleware(middlewares ...Middleware)

+ func (sc *StaticFileServer) WithLogger(log *logger.Logger) *StaticFileServer

+ type StaticResult struct

+ FilePath string

+ FileSystem http.FileSystem

+ Headers http.Header

+ RewriteRules []RewriteRule

+ func NewStaticResultForFile(filePath string) *StaticResult

+ func (sr StaticResult) Render(ctx *Ctx) error

+ type StatusViewModel struct

+ Response interface{}

+ StatusCode int

+ type SyncState struct

+ Values map[string]Any

+ func (s *SyncState) Copy() State

+ func (s *SyncState) Get(key string) Any

+ func (s *SyncState) Keys() (output []string)

+ func (s *SyncState) Remove(key string)

+ func (s *SyncState) Set(key string, value Any)

+ type TCPKeepAliveListener struct

+ func (ln TCPKeepAliveListener) Accept() (net.Conn, error)

+ type TLSConfig struct

+ CAPaths []string

+ Cert []byte

+ CertPath string

+ Key []byte

+ KeyPath string

+ func (tc TLSConfig) GetCAPaths(defaults ...[]string) []string

+ func (tc TLSConfig) GetCert(defaults ...[]byte) []byte

+ func (tc TLSConfig) GetCertPath(defaults ...string) string

+ func (tc TLSConfig) GetConfig() (*tls.Config, error)

+ func (tc TLSConfig) GetKey(defaults ...[]byte) []byte

+ func (tc TLSConfig) GetKeyPath(defaults ...string) string

+ func (tc TLSConfig) HasKeyPair() bool

+ type TextResultProvider struct

+ var Text TextResultProvider

+ func (trp TextResultProvider) BadRequest(err error) Result

+ func (trp TextResultProvider) InternalError(err error) Result

+ func (trp TextResultProvider) NotAuthorized() Result

+ func (trp TextResultProvider) NotFound() Result

+ func (trp TextResultProvider) OK() Result

+ func (trp TextResultProvider) Result(result interface{}) Result

+ func (trp TextResultProvider) Status(statusCode int, response ...interface{}) Result

+ type TraceFinisher interface

+ Finish func(*Ctx, error)

+ type Tracer interface

+ Start func(*Ctx) TraceFinisher

+ type Values = map[string]interface

+ type ViewCache struct

+ func NewViewCache() *ViewCache

+ func NewViewCacheFromConfig(cfg *ViewCacheConfig) *ViewCache

+ func (vc *ViewCache) AddLiterals(views ...string)

+ func (vc *ViewCache) AddPaths(paths ...string)

+ func (vc *ViewCache) BadRequest(err error) Result

+ func (vc *ViewCache) BadRequestTemplateName() string

+ func (vc *ViewCache) Cached() bool

+ func (vc *ViewCache) FuncMap() template.FuncMap

+ func (vc *ViewCache) Initialize() error

+ func (vc *ViewCache) Initialized() bool

+ func (vc *ViewCache) InternalError(err error) Result

+ func (vc *ViewCache) InternalErrorTemplateName() string

+ func (vc *ViewCache) Literals() []string

+ func (vc *ViewCache) Lookup(name string) (*template.Template, error)

+ func (vc *ViewCache) NotAuthorized() Result

+ func (vc *ViewCache) NotAuthorizedTemplateName() string

+ func (vc *ViewCache) NotFound() Result

+ func (vc *ViewCache) NotFoundTemplateName() string

+ func (vc *ViewCache) Parse() (views *template.Template, err error)

+ func (vc *ViewCache) Paths() []string

+ func (vc *ViewCache) SetLiterals(viewLiterals ...string)

+ func (vc *ViewCache) SetPaths(paths ...string)

+ func (vc *ViewCache) SetTemplates(viewCache *template.Template)

+ func (vc *ViewCache) Status(statusCode int, response ...interface{}) Result

+ func (vc *ViewCache) StatusTemplateName() string

+ func (vc *ViewCache) Templates() (*template.Template, error)

+ func (vc *ViewCache) View(viewName string, viewModel interface{}) Result

+ func (vc *ViewCache) WithBadRequestTemplateName(templateName string) *ViewCache

+ func (vc *ViewCache) WithCached(cached bool) *ViewCache

+ func (vc *ViewCache) WithInternalErrorTemplateName(templateName string) *ViewCache

+ func (vc *ViewCache) WithNotAuthorizedTemplateName(templateName string) *ViewCache

+ func (vc *ViewCache) WithNotFoundTemplateName(templateName string) *ViewCache

+ func (vc *ViewCache) WithStatusTemplateName(templateName string) *ViewCache

+ type ViewCacheConfig struct

+ BadRequestTemplateName string

+ BufferPoolSize int

+ Cached *bool

+ InternalErrorTemplateName string

+ NotAuthorizedTemplateName string

+ NotFoundTemplateName string

+ Paths []string

+ StatusTemplateName string

+ func (vcc ViewCacheConfig) GetBadRequestTemplateName(defaults ...string) string

+ func (vcc ViewCacheConfig) GetBufferPoolSize(defaults ...int) int

+ func (vcc ViewCacheConfig) GetCached(defaults ...bool) bool

+ func (vcc ViewCacheConfig) GetInternalErrorTemplateName(defaults ...string) string

+ func (vcc ViewCacheConfig) GetNotAuthorizedTemplateName(defaults ...string) string

+ func (vcc ViewCacheConfig) GetNotFoundTemplateName(defaults ...string) string

+ func (vcc ViewCacheConfig) GetPaths(defaults ...[]string) []string

+ func (vcc ViewCacheConfig) GetStatusTemplateName(defaults ...string) string

+ type ViewModel struct

+ Ctx *Ctx

+ Env env.Vars

+ ViewModel interface{}

+ type ViewResult struct

+ StatusCode int

+ Template *template.Template

+ ViewModel interface{}

+ ViewName string

+ Views *ViewCache

+ func (vr *ViewResult) Render(ctx *Ctx) (err error)

+ type ViewTraceFinisher interface

+ Finish func(*Ctx, *ViewResult, error)

+ type ViewTracer interface

+ StartView func(*Ctx, *ViewResult) ViewTraceFinisher

+ type XMLResult struct

+ Response interface{}

+ StatusCode int

+ func (ar *XMLResult) Render(ctx *Ctx) error

+ type XMLResultProvider struct

+ var XML XMLResultProvider

+ func (xrp XMLResultProvider) BadRequest(err error) Result

+ func (xrp XMLResultProvider) InternalError(err error) Result

+ func (xrp XMLResultProvider) NotAuthorized() Result

+ func (xrp XMLResultProvider) NotFound() Result

+ func (xrp XMLResultProvider) OK() Result

+ func (xrp XMLResultProvider) Result(result interface{}) Result

+ func (xrp XMLResultProvider) Status(statusCode int, response ...interface{}) Result

Incompatible versions in this module

v2.0.0+incompatible

Apr 1, 2019

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