application

package module

Go to main page

Versions in this module

v0

v0.6.0

Jul 15, 2026

Changes in this version

+ func ConfigFileSource(filename string) config.Source

type Option

+ func WithConfigSources(sources ...config.Source) Option

v0.5.0

Jul 15, 2026

Changes in this version

type Application

+ func (a *Application) WriteConfigTemplate(ctx context.Context, writer io.Writer) error

v0.4.1

Jul 14, 2026

v0.4.0

Jul 14, 2026

Changes in this version

type Option

+ func WithEnvPrefix(prefix string) Option

v0.3.0

Jul 14, 2026

Changes in this version

+ var ErrApplicationBusy = errors.New("application operation already in progress")

+ var ErrConfigBindingPhase = errors.New("configuration bindings may only be registered during module initialization")

+ var ErrDuplicateModule = errors.New("module already registered")

+ var ErrInvalidConfigTarget = errors.New("configuration target must be a non-nil pointer to a struct or map")

+ var ErrInvalidState = errors.New("invalid application state")

+ var ErrModulesFrozen = errors.New("module registration is frozen")

+ var ErrNoConfigFile = errors.New("application has no configuration file")

+ var ErrNotRunning = errors.New("application is not running")

type Application

+ func (a *Application) Module(name string) (Module, bool)

+ func (a *Application) Modules() iter.Seq2[string, Module]

+ func (a *Application) Reload(ctx context.Context) error

+ func (a *Application) Shutdown(cause error) error

+ func (a *Application) State() State

type Configuration

+ func (c Configuration) ReloadFile(ctx context.Context, filename string) hcl.Diagnostics

+ type Context struct

+ func (c *Context) Application() *Application

+ func (c *Context) BindConfig(target any) error

+ func (c *Context) Cause() error

+ func (c *Context) Logger() *slog.Logger

+ func (c *Context) Settings() *config.Set

+ func (c *Context) Shutdown(cause error) error

+ func (c *Context) State() State

type Option

+ func WithShutdownTimeout(timeout time.Duration) Option

+ type PhaseError struct

+ Err error

+ Module string

+ Phase string

+ func (e *PhaseError) Error() string

+ func (e *PhaseError) Unwrap() error

+ type PostStopper interface

+ PostStop func(ctx *Context) error

+ type PreStopper interface

+ PreStop func(ctx *Context) error

+ type RunOption func(*runOptions) error

+ func WithInstall() RunOption

+ func WithSignals(signals ...os.Signal) RunOption

+ type State uint8

+ const StateConfiguring

+ const StateFailed

+ const StateInitializing

+ const StateInstalling

+ const StateNew

+ const StateReady

+ const StateRunning

+ const StateStarting

+ const StateStopped

+ const StateStopping

+ func (s State) String() string

v0.2.1

Jul 10, 2026

Changes in this version

+ var ErrInvalidObjectPath = errors.New("invalid object path")

+ func Run(name, version string, opts ...Option) error

+ type Application struct

+ Controller *Controller

+ Logger *slog.Logger

+ Name string

+ Settings *config.Set

+ Version string

+ func FromContext(ctx context.Context) *Application

+ func New(name, version string, opts ...Option) *Application

+ func (a *Application) Exit(err error)

+ func (a *Application) Install(ctx context.Context) error

+ func (a *Application) Run(ctx context.Context) error

+ func (a *Application) String() string

+ func (a *Application) Validate(ctx context.Context) error

+ type Configurable interface

+ Config func() (any, error)

+ type ConfigurableNotify interface

+ ConfigSet func(any) error

+ type Configuration struct

+ func (Configuration) EvalContext(ctx context.Context) *hcl.EvalContext

+ func (c Configuration) Decode(ctx context.Context, filename string, src []byte) hcl.Diagnostics

+ func (c Configuration) DecodeFile(ctx context.Context, filename string) hcl.Diagnostics

+ type Controller struct

+ func (c *Controller) Add(name string, m Module)

+ func (c *Controller) Get(name string) Module

+ func (c *Controller) Range(cb func(name string, module Module) bool)

+ func (c *Controller) Remove(name string)

+ func (c *Controller) Run(ctx context.Context) error

+ type Error struct

+ Errors []error

+ func (e *Error) Append(err error) *Error

+ func (e Error) Err() error

+ func (e Error) Error() string

+ func (e Error) Unwrap() error

+ type Initializer interface

+ Initialize func(ctx context.Context) (context.Context, error)

+ type Installer interface

+ Install func(ctx context.Context) error

+ type Module interface

+ Start func(ctx context.Context) error

+ Stop func(ctx context.Context) error

+ type Option func(app *Application)

+ func WithConfigFile(filename string) Option

+ func WithLogger(logger *slog.Logger) Option

+ func WithModule(name string, m Module) Option

+ type PostStarter interface

+ PostStart func(ctx context.Context) error

+ type PreStarter interface

+ PreStart func(ctx context.Context) error

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL