mod

README

mod

Small module system build on go.uber.org/dig

Documentation

Index

• func CloseAll(ctx context.Context, closers ...*CloseHook) []error
• func GetFunctionName(function any) string
• func Run(routine any, modules ...ModuleProvider) (runtimeErr error, closeErrs []error)
• type CloseHook
• type Closer
  • func NilCloser() Closer
  • func OnClose(order int, name string, close func(context.Context) error) Closer
• type Closers
• type InitHook
• type Initializer
  • func NilInit() Initializer
  • func OnInit(order int, name string, init func(context.Context) error) Initializer
• type Initializers
• type Module
  • func LoadModules(submodules ...ModuleProvider) Module
• type ModuleProvider

Functions

func CloseAll

func CloseAll(ctx context.Context, closers ...*CloseHook) []error

func GetFunctionName

func GetFunctionName(function any) string

func Run

func Run(routine any, modules ...ModuleProvider) (runtimeErr error, closeErrs []error)

Types

type CloseHook

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

type Closer

type Closer struct {
	dig.Out

	Hook *CloseHook `group:"closers"`
}

func NilCloser

func NilCloser() Closer

func OnClose

func OnClose(order int, name string, close func(context.Context) error) Closer

type Closers

type Closers struct {
	dig.In

	Closers []*CloseHook `group:"closers"`
}

type InitHook

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

type Initializer

type Initializer struct {
	dig.Out

	Hook *InitHook `group:"initializers"`
}

func NilInit

func NilInit() Initializer

func OnInit

func OnInit(order int, name string, init func(context.Context) error) Initializer

type Initializers

type Initializers struct {
	dig.In

	Initializers []*InitHook `group:"initializers"`
}

type Module

type Module interface {
	Sub(provider ModuleProvider)
	Public(service any)
	Private(service any)
	Run(runtime any) (runtimeErr error, closeErrs []error)
	Init([]*InitHook) []error
	Finalize([]*CloseHook) []error
	// contains filtered or unexported methods
}

func LoadModules

func LoadModules(submodules ...ModuleProvider) Module

type ModuleProvider

type ModuleProvider func(Module)