package
0.0.0-20240808225702-1f1c2144e8b2
Repository: https://github.com/akraino-edge-stack/iec.git
Documentation: pkg.go.dev
# README
Revel Framework
A high productivity, full-stack web framework for the Go language.
Current Version: 0.21.0 (2018-10-30)
Because of Default HTTP Server's graceful shutdown, Go 1.8+ is required.
Quick Start
Enter Go's path (format varies based on OS):
cd $GOPATH
Install Revel:
go get -u github.com/revel/cmd/revel
Create & Run your app:
revel new -a my-app -r
Open http://localhost:9000 in your browser and you should see "It works!"
Community
Learn More
Contributing
Contributors
# Packages
No description provided by the author
Package logger contains filters and handles for the logging utilities in Revel.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
# Functions
No description provided by the author
Adds the controller to the controllers map using its namespace, also adds it to the module list of controllers.
Adds this routehandler to the route table.
Add event handler to listen for all system events.
Atob converts string into boolean.
Autocalls any defined before and after methods on the target controller If either calls returns a value then the result is returned.
Bind takes the name and type of the desired parameter and constructs it from one or more values from Params.
No description provided by the author
No description provided by the author
CheckInit method checks `revel.Initialized` if not initialized it panics.
ClientIP method returns client IP address from HTTP request.
CompressFilter does compression of response body in gzip/deflate if `results.compressed=true` in the app.conf.
No description provided by the author
ContentTypeByFilename returns a MIME content type based on the filename's extension.
No description provided by the author
DirExists returns true if the given path exists and is a directory.
No description provided by the author
Equal is a helper for comparing value equality, following these rules: - Values with equivalent types are compared with reflect.DeepEqual - int, uint, and float values are compared without regard to the type width.
ExecuteTemplate execute a template and returns the result as a string.
FilterAction returns a configurator for the filters applied to the given controller method.
FilterConfiguringFilter is a filter stage that customizes the remaining filter chain for the action being invoked.
FilterController returns a configurator for the filters applied to all actions on the given controller instance.
FilterEq returns true if the two filters reference the same filter.
FindMethod returns the reflect.Method, given a Receiver type and Func value.
No description provided by the author
FlashFilter is a Revel Filter that retrieves and sets the flash cookie.
ClientIP method returns client IP address from HTTP request.
HTTPMethodOverride overrides allowed http methods via form or browser param.
No description provided by the author
Init initializes Revel -- it provides paths for getting around the app.
InitServer initializes the server and returns the handler It can be used as an alternative entry-point if one needs the http handler to be exposed.
Build an engine initialization object and start the engine.
InterceptFunc installs a general interceptor.
InterceptMethod installs an interceptor method that applies to its own Controller.
No description provided by the author
LoadMimeConfig load mime-types.conf on init.
Message performs a message look-up for the given locale and message using the given arguments.
MessageLanguages returns all currently loaded message languages.
ModuleByName returns the module of the given name, if loaded, case insensitive.
Based on the full path given return the relevant module Only to be used on initialization.
MustReadLines reads the lines of the given file.
No description provided by the author
Creates a new instance based on the ServerHeader.
New controller, creates a new instance wrapping the request and response in it.
NewController returns new controller instance for Request and Response.
No description provided by the author
NewErrorFromPanic method finds the deepest stack from in user code and provide a code listing of that, on the line that eventually triggered the panic.
No description provided by the author
Create a new go context.
NewRequest returns a Revel's HTTP request instance with given HTTP instance.
NewResponse wraps ServerResponse inside a Revel's Response and returns it.
NewRoute prepares the route to be used in matching.
No description provided by the author
For testing purposes this engine is used.
No description provided by the author
No description provided by the author
OnAppStart registers a function to be run at app startup.
Called to add a new stop hook.
PanicFilter wraps the action invocation in a protective defer blanket that converts panics into 500 error pages.
No description provided by the author
ParseKeyValueCookie takes the raw (escaped) cookie value and parses out key values.
ParseParams parses the `http.Request` params into `revel.Controller.Params`.
Parse the line, and description from an error message like: html/template:Application/Register.html:36: no such template "footer.html".
Fires system events from revel.
ReadLines reads the lines of the given file.
RegisterController registers a Controller and its Methods with Revel.
Called by a module init() function, caller will receive the *Module object created for that module This would be useful for assigning a logger for logging information in the module (since the module context would be correct).
No description provided by the author
No description provided by the author
Allow for templates to be registered during init but not initialized until application has been started.
ResolveAcceptLanguage returns a sorted list of Accept-Language header values.
ResolveContentType gets the content type.
ResolveFormat maps the request's Accept MIME type declaration to a Request.Format attribute, specifically "html", "xml", "json", or "txt", returning a default of "html" when Accept header cannot be mapped to a value above.
ResolveImportPath returns the filesystem path for the given import path.
ReverseURL returns a url capable of invoking a given controller method: "Application.ShowApp 123" => "/app/123".
No description provided by the author
Run the server.
No description provided by the author
Set the secret key.
Sign a given string with the app-configured secret key.
No description provided by the author
Called to stop the server.
TemplateOutputArgs returns the result of the template rendered using the passed in arguments.
No description provided by the author
ToBool method converts/assert value into true or false.
No description provided by the author
ValidationFilter revel Filter function to be hooked into the filter chain.
No description provided by the author
No description provided by the author
No description provided by the author
Requires an IP Address string to be exactly a given validation type (IPv4, IPv6, IPv4MappedIPv6, IPv4CIDR, IPv6CIDR, IPv4MappedIPv6CIDR OR IPAny).
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
ValueBinder is adapter for easily making one-key-value binders.
Verify returns true if the given signature is correct for the given message.
Walk method extends filepath.Walk to also follow symlinks.
# Constants
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
BuildDate latest commit/release date.
CurrentLocaleViewArg the key for the current locale view arg value.
Revel's default date and time constants.
Revel's default date and time constants.
DefaultFileContentType Revel's default response content type.
Event type before server engine is initialized, receivers are active server engine and handlers added to AddInitEventHandler.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Event type after server engine is stopped, receivers are active server engine and handlers added to AddInitEventHandler.
Event raised when the engine is told to shutdown.
Event type before server engine is started, receivers are active server engine and handlers added to AddInitEventHandler.
No description provided by the author
No description provided by the author
The server key name.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
HTTP Engine Type Values Starts at 1000 */.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
IPv4 (32 chars).
No description provided by the author
IP4-mapped IPv6 (45 chars) , Ex) ::FFFF:129.144.52.38.
No description provided by the author
IPv6(39 chars).
No description provided by the author
MinimumGoVersion minimum required Go version for Revel.
No description provided by the author
NORMAL BenchmarkRegex-8 2000000000 0.24 ns/op
STRICT BenchmarkLoop-8 2000000000 0.01 ns/op
*/.
No description provided by the author
No description provided by the author
Event type after all module loads, events thrown to handlers added to AddInitEventHandler.
Event type before all module loads, events thrown to handlers added to AddInitEventHandler.
Fired when a panic is caught during the startup process.
RevelImportPath Revel framework import path.
Called after routes have been refreshed.
Called before routes are refreshed.
No description provided by the author
NORMAL BenchmarkRegex-8 2000000000 0.24 ns/op
STRICT BenchmarkLoop-8 2000000000 0.01 ns/op
*/.
Event type when templates are refreshed (receivers are registered template engines added to the template.engine conf option).
Event type when templates are going to be refreshed (receivers are registered template engines added to the template.engine conf option).
No description provided by the author
Version current Revel version.
# Variables
This logger is the application logger, use this for your application log messages - ie jobs and startup, Use Controller.Log for Controller logging The requests are logged to this logger with the context of `section:requestlog`.
e.g.
e.g.
e.g.
No description provided by the author
e.g.
Booleans support a various value formats, refer `revel.Atob` method.
Code base directories, for modules and app.
App details.
ConfPaths where to look for configurations Config load order 1.
Cookie domain.
All cookies dropped by the framework begin with this prefix.
Cookie flags.
Revel's variables server, router, etc.
No description provided by the author
Binders type and kind definition.
Binders type and kind definition.
DefaultValidationKeys register default validation keys for all calls to Controller.Validation.Func().
if true, RunMode is a development mode.
No description provided by the author
ErrorCSSClass httml CSS error class name.
Filters is the default set of global filters.
Binders type and kind definition.
No description provided by the author
No description provided by the author
No description provided by the author
e.g.
e.g.
e.g.
e.g.
e.g.
e.g.
True when revel engine has been initialized (Init has returned).
No description provided by the author
Binders type and kind definition.
Binders type and kind definition.
Revel's variables server, router, etc.
Revel's variables server, router, etc.
Revel's variables server, router, etc.
Binders type and kind definition.
MessageFunc allows you to override the translation interface.
The list of modules in use.
NilFilter and NilChain are helpful in writing filter tests.
NilFilter and NilChain are helpful in writing filter tests.
No description provided by the author
Binders type and kind definition.
App details.
This is the logger revel writes to, added log messages will have a context of module:revel in them It is based off of `RootLog`.
e.g.
The root log is what all other logs are branched from, meaning if you set the handler for the root it will adjust all children.
Application-defined (by default, "dev" or "prod").
Revel's variables server, router, etc.
e.g.
Binders type and kind definition.
System logger.
The functions available for use in the templates.
Template path directories manually added.
Binders type and kind definition.
Applications can add custom time formats to this array, and they will be automatically attempted when binding a time.Time.
Binders type and kind definition.
These are the lookups to find a Binder for any type of data.
Binders type and kind definition.
e.g.
No description provided by the author
# Structs
AcceptLanguage is a single language from the Accept-Language HTTP header.
No description provided by the author
No description provided by the author
No description provided by the author
A Binder translates between string parameters and Go data structures.
BufferedServerHeader will not send content out until the Released is called, from that point on it will act normally It implements all the ServerHeader.
The compressed writer.
Controller Revel's controller structure that gets embedded in user defined controllers.
The controller field path provides the caller the ability to invoke the call directly.
Controller registry and types.
No description provided by the author
Requires a Domain string to be exactly.
No description provided by the author
No description provided by the author
Error description, used as an argument to the error template.
ErrorResult structure used to handles all kinds of error codes (500, 404, ..).
Field represents a data field that may be collected in a web form.
Requires an string to be sanitary file path.
FilterConfigurator allows the developer configure the filter chain on a per-controller or per-action basis.
Flash represents a cookie that is overwritten on each request.
No description provided by the author
The main template engine for Go.
No description provided by the author
The Go HTTP server.
No description provided by the author
No description provided by the author
No description provided by the author
Adapter for Go Templates.
No description provided by the author
No description provided by the author
Requires a string(IP Address) to be within IP Pattern type inclusive.
Length requires an array or string to be exactly a given length.
Requires a MAC Address string to be exactly.
Match requires a string to match a given regex.
No description provided by the author
MaxSize requires an array or string to be at most a given length.
No description provided by the author
No description provided by the author
No description provided by the author
MinSize requires an array or string to be at least a given length.
Module specific functions.
Deprecated for backwards compatibility only.
The output response.
Params provides a unified view of the request params.
No description provided by the author
Requires a string to be without invisible characters.
Range requires an integer to be within Min, Max inclusive.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
RenderTemplateResult action methods returns this result to request a template be rendered.
No description provided by the author
No description provided by the author
Request is Revel's HTTP request object structure.
No description provided by the author
Response is Revel's HTTP response object structure.
The header defined in Revel.
The list of startup hooks.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
SourceLine structure to hold the per-source-line details.
TemplateLoader object handles loading and parsing of templates.
The template view information.
No description provided by the author
Validation context manages data validation and error messages.
ValidationError simple struct to store the Message & Key of a validation error.
ValidationResult is returned from every validation method.
Watcher allows listeners to register to be notified of changes under a given directory.
# Interfaces
DiscerningListener allows the receiver to selectively watch files.
No description provided by the author
ExecutableTemplate adds some more methods to the default Template.
No description provided by the author
Listener is an interface for receivers of filesystem events.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
The session engine provides an interface to allow for storage of session data.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
WriteFlusher interface for compress writer.
# Type aliases
AcceptLanguages is collection of sortable AcceptLanguage instances.
No description provided by the author
No description provided by the author
No description provided by the author
No description provided by the author
Filter type definition for Revel's filter.
No description provided by the author
An InterceptorFunc is functionality invoked by the framework BEFORE or AFTER an action.
No description provided by the author
Modules can be called back after they are loaded in revel by using this interface.
The list of startup hooks.
No description provided by the author
No description provided by the author