Categorygithub.com/portcullis/application
modulepackage
0.2.0
Repository: https://github.com/portcullis/application.git
Documentation: pkg.go.dev

# Packages

Package confighcl allows decoding HCL configurations into config data structures.

# Functions

FromContext extracts the Appliation instance if it exists from the provided context or nil if not found.
New creates a new application and executes the options.
Run creates an application with the specified name and version, applies the provided options, and begins execution.
WithConfigFile adds hcl parsing capability to the application and loads the provided filename.
WithLogger will set the internal slog.Logger instance.
WithModule adds the specified module to the application for execution.

# Variables

ErrInvalidObjectPath is returned when a key cannot be converted into a nested object path like "foo...bar", ".foo", or "foo.".

# Structs

Application defines an instance of an application.
Configuration for the application based on github.com/hashicorp/hcl/v2.
Controller for modules.
Error for modules containing multiple errors.

# Interfaces

Configurable can be optionally implemented by any module to accept user configuration.
ConfigurableNotify is an optional interface that can be implemented by any module to receive a notification that the configuration was decoded.
Initializer allows for context modifications before start.
Installer allows for modules to install things before and modul.PreStart is called, and is used in the application.Install function.
Module represents an interface into a start stop module.
PostStarter allows for additional functionality after all Module.Start are called.
PreStarter allows for additional functionality before any Module.Start is called.

# Type aliases

Option for an Application.