Iris Web Framework

Package i18n provides internalization and localization features for Iris.

Addr can be used as an argument for the `Run` method.

AutoTLS can be used as an argument for the `Run` method.

Default returns a new Application instance which on build state registers html view engine on "./views" and load locales from "./locales/*/*".

DefaultConfiguration returns the default configuration for an iris station, fills the main Configuration.

Listener can be used as an argument for the `Run` method.

New creates and returns a fresh empty iris *Application instance.

PrefixDir returns a new FileSystem that opens files by adding the given "prefix" to the directory tree of "fs".

Raw can be used as an argument for the `Run` method.

Server can be used as an argument for the `Run` method.

TLS can be used as an argument for the `Run` method.

TOML reads Configuration from a toml-compatible document file.

WithCharset sets the Charset setting.

WithConfiguration sets the "c" values to the framework's configurations.

WithHostProxyHeader sets a HostProxyHeaders key value pair.

WithLogLevel sets the `Configuration.LogLevel` field.

WithOtherValue adds a value based on a key to the Other setting.

WithoutRemoteAddrHeader removes an existing request header name that can be used to validate and parse the client's real IP.

WithoutServerError will cause to ignore the matched "errors" from the main application's `Run/Listen` function.

WithPostMaxMemory sets the maximum post data size that a client can send to the server, this differs from the overral request body size which can be modified by the `context#SetMaxRequestBodySize` or `iris#LimitRequestBodySize`.

WithRemoteAddrHeader adds a new request header name that can be used to validate the client's real IP.

WithRemoteAddrPrivateSubnet adds a new private sub-net to be excluded from `context.RemoteAddr`.

WithSitemap enables the sitemap generator.

WithSocketSharding sets the `Configuration.SocketSharding` field to true.

WithSSLProxyHeader sets a SSLProxyHeaders key value pair.

WithTimeFormat sets the TimeFormat setting.

YAML reads Configuration from a configuration.yml file.

Byte unit helpers.

Byte unit helpers.

Byte unit helpers.

Byte unit helpers.

Byte unit helpers.

HTTP Methods copied from `net/http`.

HTTP Methods copied from `net/http`.

HTTP Methods copied from `net/http`.

HTTP Methods copied from `net/http`.

MethodNone is an iris-specific "virtual" method to store the "offline" routes.

HTTP Methods copied from `net/http`.

HTTP Methods copied from `net/http`.

HTTP Methods copied from `net/http`.

HTTP Methods copied from `net/http`.

HTTP Methods copied from `net/http`.

NoLayout to disable layout for a particular template file A shortcut for the `view#NoLayout`.

Byte unit helpers.

Contains the enum values of the `Context.GetReferrer()` method, shortcuts of the context subpackage.

Contains the enum values of the `Context.GetReferrer()` method, shortcuts of the context subpackage.

Contains the enum values of the `Context.GetReferrer()` method, shortcuts of the context subpackage.

Contains the enum values of the `Context.GetReferrer()` method, shortcuts of the context subpackage.

Contains the enum values of the `Context.GetReferrer()` method, shortcuts of the context subpackage.

Contains the enum values of the `Context.GetReferrer()` method, shortcuts of the context subpackage.

Contains the enum values of the `Context.GetReferrer()` method, shortcuts of the context subpackage.

Contains the enum values of the `Context.GetReferrer()` method, shortcuts of the context subpackage.

Contains the enum values of the `Context.GetReferrer()` method, shortcuts of the context subpackage.

RouteError log when a route already exists, shown after the `Build` state, server never starts.

RouteOverlap will overlap the new route to the previous one.

RouteOverride replaces an existing route with the new one, the default rule.

RouteSkip keeps the original route and skips the new one.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

Unofficial Server Errors.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

Unofficial Client Errors.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

HTTP status codes as registered with IANA.

Byte unit helpers.

Version is the current version number of the Iris Web Framework.

Ace view engine.

Amber view engine.

AutoTLSNoRedirect is a `host.Configurator`.

Blocks view engine.

Cache is a middleware providing server-side cache functionalities to the next handlers, can be used as: `app.Get("/", iris.Cache, aboutHandler)`.

Cache304 sends a `StatusNotModified` (304) whenever the "If-Modified-Since" request header (time) is before the time.Now() + expiresEvery (always compared to their UTC values).

Compression is a middleware which enables writing and reading using the best offered compression.

CookieAllowReclaim accepts the Context itself.

CookieAllowSubdomains set to the Cookie Options in order to allow subdomains to have access to the cookies.

CookieCleanPath is a `CookieOption`.

CookieEncoding accepts a value which implements `Encode` and `Decode` methods.

CookieExpires is a `CookieOption`.

CookieHTTPOnly is a `CookieOption`.

CookiePath is a `CookieOption`.

CookieSameSite sets a same-site rule for cookies to set.

CookieSecure sets the cookie's Secure option if the current request's connection is using TLS.

DirListRich can be passed to `DirOptions.DirList` field to override the default file listing appearance.

Django view engine.

ErrEmptyForm is the type error which API users can make use of to check if a form was empty on `Context.ReadForm`.

ErrHijackNotSupported is returned by the Hijack method to indicate that Hijack feature is not available.

ErrPushNotSupported is returned by the Push method to indicate that HTTP/2 Push support is not available.

ErrServerClosed is returned by the Server's Serve, ServeTLS, ListenAndServe, and ListenAndServeTLS methods after a call to Shutdown or Close.

ErrStopExecution if returned from a hero middleware or a request-scope dependency stops the handler's execution, see _examples/dependency-injection/basic/middleware.

FileServer returns a Handler which serves files from a specific system, phyisical, directory or an embedded one.

FromStd converts native http.Handler, http.HandlerFunc & func(w, r, next) to context.Handler.

Handlebars view engine.

HTML view engine.

IsErrPath can be used at `context#ReadForm` and `context#ReadQuery`.

Jet view engine.

LimitRequestBodySize is a middleware which sets a request body size limit for all next handlers in the chain.

MatchCommonAssets is a simple regex expression which can be used on `DirOptions.PushTargetsRegexp`.

MatchImagesAssets is a simple regex expression that can be passed to the DirOptions.Cache.CompressIgnore field in order to skip compression on already-compressed file types such as images and pdf.

NewConditionalHandler returns a single Handler which can be registered as a middleware.

NewProblem returns a new Problem.

NoCache is a middleware which overrides the Cache-Control, Pragma and Expires headers in order to disable the cache during the browser's back and forward feature.

Pug view engine.

RegisterOnInterrupt registers a global function to call when CTRL+C/CMD+C pressed or a unix kill command received.

StaticCache middleware for caching static files by sending the "Cache-Control" and "Expires" headers to the client.

StatusText returns a text for the HTTP status code.

StripPrefix returns a handler that serves HTTP requests by removing the given prefix from the request URL's Path and invoking the handler h.

TLSNoRedirect is a `host.Configurator` which can be passed as last argument to the `TLS` runner function.

WithEmptyFormError enables the setting `FireEmptyFormError`.

WithFireMethodNotAllowed enables the FireMethodNotAllowed setting.

WithGlobalConfiguration will load the global yaml configuration file from the home directory and it will set/override the whole app's configuration to that file's contents.

WithLowercaseRouting enables for lowercase routing by setting the `ForceLowercaseRoutes` to true.

WithOptimizations can force the application to optimize for the best performance where is possible.

WithoutAutoFireStatusCode sets the DisableAutoFireStatusCode setting to true.

WithoutBanner is a conversion for the `WithoutStartupLog` option.

WithoutBodyConsumptionOnUnmarshal disables BodyConsumptionOnUnmarshal setting.

WithoutInterruptHandler disables the automatic graceful server shutdown when control/cmd+C pressed.

WithoutPathCorrection disables the PathCorrection setting.

WithoutPathCorrectionRedirection disables the PathCorrectionRedirection setting.

WithoutStartupLog turns off the information send, once, to the terminal when the main server is open.

WithPathEscape sets the EnablePathEscape setting to true.

WithPathIntelligence enables the EnablePathIntelligence setting.

WithResetOnFireErrorCode sets the ResetOnFireErrorCode setting to true.

WithTunneling is the `iris.Configurator` for the `iris.Configuration.Tunneling` field.

XMLMap wraps a map[string]interface{} to compatible xml marshaler, in order to be able to render maps as XML on the `Context.XML` method.

Application is responsible to manage the state of the application.

Configuration holds the necessary settings for an Iris Application instance.

Configurator is just an interface which accepts the framework instance.

Runner is just an interface which accepts the framework instance and returns an error.