engine

package

v0.0.0-...-81cdc2d Latest Latest Go to latest Published: Apr 9, 2024 License: Apache-2.0 Imports: 16 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

This section is empty.

This section is empty.

This section is empty.

type Engine struct {
	// contains filtered or unexported fields
}

Engine is the framework's instance, it contains the configs, beans and app infos. Create an instance of Engine, by using New()/Default()

func Default(conf *framework.AppConfig) *Engine

Default returns an Engine instance with a gin bean, the gin server has logger and metrics already attached.

func New(conf *framework.AppConfig) *Engine

New returns a new blank Engine instance without any beans/config attached.

func (e *Engine) GetBeanByName(name string) (framework.Bean, bool)

func (e *Engine) GetCommand(ctx context.Context) *cobra.Command

func (e *Engine) GetConfigByName(name string) (framework.Config, bool)

func (e *Engine) Run(ctx context.Context) error

func (e *Engine) RunCommand(ctx context.Context) error

Run starts the Uitron framework. Note: if there is no bean in beans, Run will not block the calling goroutine.

func (e *Engine) UseBean(name string, conf framework.Config, bean framework.Bean) error

func (e *Engine) UseBeanWithConfig(name string, confBean framework.Bean) error

func (e *Engine) UseConfig(name string, conf framework.Config) error

func (e *Engine) UseConfigs(confs map[string]framework.Config) error

func (e *Engine) UseRouterGroups(grprouters router.GroupsRouters)

UseRouterGroups is a shortcut for setting default gin routers

func (e *Engine) UseRouters(routers router.Routers)

UseRouters is a shortcut for setting default gin routers