mirror of
https://github.com/kataras/iris.git
synced 2025-01-23 18:51:03 +01:00
78 lines
2.9 KiB
Go
78 lines
2.9 KiB
Go
package context
|
|
|
|
import (
|
|
stdContext "context"
|
|
"io"
|
|
"net/http"
|
|
|
|
"github.com/kataras/golog"
|
|
)
|
|
|
|
// Application is the context's owner.
|
|
// This interface contains the functions that can be used with safety inside a Handler
|
|
// by `context.Application()`.
|
|
type Application interface {
|
|
// ConfigurationReadOnly returns all the available configuration values can be used on a request.
|
|
ConfigurationReadOnly() ConfigurationReadOnly
|
|
|
|
// Logger returns the golog logger instance(pointer) that is being used inside the "app".
|
|
Logger() *golog.Logger
|
|
|
|
// I18nReadOnly returns the i18n's read-only features.
|
|
I18nReadOnly() I18nReadOnly
|
|
|
|
// Validate validates a value and returns nil if passed or
|
|
// the failure reason if not.
|
|
Validate(interface{}) error
|
|
|
|
// View executes and write the result of a template file to the writer.
|
|
//
|
|
// Use context.View to render templates to the client instead.
|
|
// Returns an error on failure, otherwise nil.
|
|
View(writer io.Writer, filename string, layout string, bindingData interface{}) error
|
|
|
|
// ServeHTTPC is the internal router, it's visible because it can be used for advanced use cases,
|
|
// i.e: routing within a foreign context.
|
|
//
|
|
// It is ready to use after Build state.
|
|
ServeHTTPC(ctx Context)
|
|
|
|
// ServeHTTP is the main router handler which calls the .Serve and acquires a new context from the pool.
|
|
//
|
|
// It is ready to use after Build state.
|
|
ServeHTTP(w http.ResponseWriter, r *http.Request)
|
|
|
|
// Shutdown gracefully terminates all the application's server hosts and any tunnels.
|
|
// Returns an error on the first failure, otherwise nil.
|
|
Shutdown(ctx stdContext.Context) error
|
|
|
|
// GetRouteReadOnly returns the registered "read-only" route based on its name, otherwise nil.
|
|
// One note: "routeName" should be case-sensitive. Used by the context to get the current route.
|
|
// It returns an interface instead to reduce wrong usage and to keep the decoupled design between
|
|
// the context and the routes.
|
|
//
|
|
// Look core/router/APIBuilder#GetRoute for more.
|
|
GetRouteReadOnly(routeName string) RouteReadOnly
|
|
|
|
// GetRoutesReadOnly returns the registered "read-only" routes.
|
|
//
|
|
// Look core/router/APIBuilder#GetRoutes for more.
|
|
GetRoutesReadOnly() []RouteReadOnly
|
|
|
|
// FireErrorCode handles the response's error response.
|
|
// If `Configuration.ResetOnFireErrorCode()` is true
|
|
// and the response writer was a recorder or a gzip writer one
|
|
// then it will try to reset the headers and the body before calling the
|
|
// registered (or default) error handler for that error code set by
|
|
// `ctx.StatusCode` method.
|
|
FireErrorCode(ctx Context)
|
|
|
|
// RouteExists reports whether a particular route exists
|
|
// It will search from the current subdomain of context's host, if not inside the root domain.
|
|
RouteExists(ctx Context, method, path string) bool
|
|
// FindClosestPaths returns a list of "n" paths close to "path" under the given "subdomain".
|
|
//
|
|
// Order may change.
|
|
FindClosestPaths(subdomain, searchPath string, n int) []string
|
|
}
|