# 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.
AddGzipHeaders just adds the headers "Vary" to "Accept-Encoding" and "Content-Encoding" to "gzip".
CookieCleanPath is a `CookieOption`.
CookieDecode is a `CookieOption`.
CookieEncode is a `CookieOption`.
CookieExpires is a `CookieOption`.
CookieHTTPOnly is a `CookieOption`.
CookiePath is a `CookieOption`.
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.
DefaultNext is the default function that executed on each middleware if `ctx.Next()` is called.
Do calls the SetHandlers(handlers) and executes the first handler, handlers should not be empty.
GetHost returns the host part of the current URI.
HandlerName returns the name, the handler function informations.
IsZeroTime reports whether t is obviously unspecified (either zero or Unix()=0).
LastCapturedContextID returns the total number of `context#String` calls.
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.
ParamResolverByTypeAndIndex will return a function that can be used to bind path parameter's exact value by its Go std type and the parameter's index based on the registered path.
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 writes these contents to the writer.
WriteXML marshals the given interface object and writes the XML response to the writer.
# Constants
AcceptEncodingHeaderKey is the header key of "Accept-Encoding".
CacheControlHeaderKey is the header key of "Cache-Control".
ContentBinaryHeaderValue header value for binary data.
ContentDispositionHeaderKey is the header key of "Content-Disposition".
ContentEncodingHeaderKey is the header key of "Content-Encoding".
ContentHTMLHeaderValue is the string of text/html response header's content type value.
ContentJavascriptHeaderValue header value for JSONP & Javascript data.
ContentJSONHeaderValue header value for JSON data.
ContentLengthHeaderKey is the header key of "Content-Length".
ContentMarkdownHeaderValue custom key/content type, the real is the text/html.
ContentTextHeaderValue header value for Text data.
ContentTypeHeaderKey is the header key of "Content-Type".
ContentXMLHeaderValue header value for XML data.
ContentYAMLHeaderValue header value for YAML data.
ETagHeaderKey is the header key of "ETag".
GzipHeaderValue is the header value of "gzip".
IfModifiedSinceHeaderKey is the header key of "If-Modified-Since".
LastModifiedHeaderKey is the header key of "Last-Modified".
NoLayout to disable layout for a particular template file.
NoWritten !=-1 => when nothing written before.
Contains the available values of the goreferrer enums.
Contains the available values of the goreferrer enums.
Contains the available values of the goreferrer enums.
Contains the available values of the goreferrer enums.
Contains the available values of the goreferrer enums.
Contains the available values of the goreferrer enums.
Contains the available values of the goreferrer enums.
Contains the available values of the goreferrer enums.
Contains the available values of the goreferrer enums.
StatusCodeWritten != 0 => when only status code written.
VaryHeaderKey is the header key of "Vary".
# Variables
DefaultJSONOptions is the optional settings that are being used inside `ctx.JSON`.
DefaultJSONPOptions is the optional settings that are being used inside `ctx.JSONP`.
DefaultMarkdownOptions is the optional settings that are being used from `WriteMarkdown` and `ctx.Markdown`.
DefaultXMLOptions is the optional settings that are being used from `ctx.XML`.
ErrPushNotSupported is returned by the Push method to indicate that HTTP/2 Push support is not available.
FormatTime returns a textual representation of the time value formatted according to the Application's configuration's TimeFormat field which defines the format.
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.
Next is the function that executed when `ctx.Next()` is called.
ParamResolvers is the global param resolution for a parameter type for a specific go std or custom type.
ParseTime parses a time header (such as the Date: header), trying each forth formats (or three if Application's configuration's TimeFormat is defaulted) that are allowed by HTTP/1.1: Application's configuration's TimeFormat or/and http.TimeFormat, time.RFC850, and time.ANSIC.
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.
StatusCodeNotSuccessful defines if a specific "statusCode" is not a valid status code for a successful response.
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.
No description provided by the author
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
No description provided by the author
No description provided by the author
CookieOption is the type of function that is accepted on context's methods like `SetCookieKV`, `RemoveCookie` and `SetCookie` as their (last) variadic input argument to amend the end cookie's form.
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{}.
No description provided by the author
No description provided by the author
TransactionScopeFunc the transaction's scope signature.
No description provided by the author