package
8.4.4+incompatible
Repository: https://github.com/codehakase/iris.git
Documentation: pkg.go.dev

# Functions

AcquireGzipResponseWriter returns a new *GzipResponseWriter from the pool.
AcquireResponseRecorder returns a new *AcquireResponseRecorder from the pool.
AcquireResponseWriter returns a new *ResponseWriter from the pool.
DecodeQuery returns the uri parameter as url (string) useful when you want to pass something to a database and be valid to retrieve it via context.Param use it only for special cases, when the default behavior doesn't suits you.
DecodeURL returns the decoded uri useful when you want to pass something to a database and be valid to retrieve it via context.Param use it only for special cases, when the default behavior doesn't suits you.
Do calls the SetHandlers(handlers) and executes the first handler, handlers should not be empty.
New creates and returns a new context pool.
NewContext returns the default, internal, context implementation.
NewTransactionErrResult returns a new transaction result with the given error message, it can be empty too, but if not then the transaction's scope is decided what to do with that.
Next calls all the next handler from the handlers chain, it should be used inside a middleware.
WriteJSON marshals the given interface object and writes the JSON response to the 'writer'.
WriteJSONP marshals the given interface object and writes the JSON response to the writer.
WriteMarkdown parses the markdown to html and renders these contents to the writer.
WriteXML marshals the given interface object and writes the XML response to the writer.

# Constants

32 MB.
NoLayout to disable layout for a particular template file.
NoWritten !=-1 => when nothing written before.
StatusCodeWritten != 0 => when only status code written.

# Variables

ErrPushNotSupported is returned by the Push method to indicate that HTTP/2 Push support is not available.
Gzip is a middleware which enables writing using gzip compression, if client supports.
LimitRequestBodySize is a middleware which sets a request body size limit for all next handlers in the chain.
Recorder the middleware to enable response writer recording ( ResponseWriter -> ResponseRecorder).
RequestTransactionScope explanation: if scope fails (if transaction.IsFailure() == true) then the rest of the context's response (transaction or normal flow) is not written to the client, and an error status code is written instead.
SetCookieKVExpiration is 2 hours by-default you can change it or simple, use the SetCookie for more control.
StaticCacheDuration expiration duration for INACTIVE file handlers, it's the only one global configuration which can be changed.
TransientTransactionScope explanation: independent 'silent' scope, if transaction fails (if transaction.IsFailure() == true) then its response is not written to the real context no error is provided to the user.

# Structs

GzipResponseWriter is an upgraded response writer which writes compressed data to the underline ResponseWriter.
JSON contains the options for the JSON (Context's) Renderer.
JSONP contains the options for the JSONP (Context's) Renderer.
Markdown contains the options for the Markdown (Context's) Renderer.
Pool is the context pool, it's used inside router and the framework by itself.
RequestParams is a key string - value string storage which context's request dynamic path params are being kept.
A ResponseRecorder is used mostly by context's transactions in order to record and change if needed the body, status code and headers.
Transaction gives the users the opportunity to code their route handlers cleaner and safier it receives a scope which is decided when to send an error to the user, recover from panics stop the execution of the next transactions and so on..
TransactionErrResult could be named also something like 'MaybeError', it is useful to send it on transaction.Complete in order to execute a custom error mesasge to the user.
XML contains the options for the XML (Context's) Renderer.

# Interfaces

Application is the context's owner.
No description provided by the author
ConfigurationReadOnly can be implemented by Configuration, it's being used inside the Context.
Context is the midle-man server's "object" for the clients.
ResponseWriter interface is used by the context to serve an HTTP handler to construct an HTTP response.
RouteReadOnly allows decoupled access to the current route inside the context.
TransactionScope is the manager of the transaction's response, can be resseted and skipped from its parent context or execute an error or skip other transactions.
No description provided by the author

# Type aliases

A Handler responds to an HTTP request.
Handlers is just a type of slice of []Handler.
Map is just a shortcut of the map[string]interface{}.
TransactionScopeFunc the transaction's scope signature.
No description provided by the author