Documentation
¶
Overview ¶
Package upmig2 provides configuration file settings upwards Migrator for settings major version 2 and its Adapter type for the version independent repo.UpMigrator[migrationuc.Settings] interface.
The settings.UpMigrator generic interface is employed in order to ensure that this version-specific implementation uses consistent types as its method return types.
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func Adapt ¶
func Adapt(m *Migrator) repo.UpMigrator[migrationuc.Settings]
Adapt creates an instance of Adapter struct wraping the `m` argument. Because Adapter expects to wrap a Type instance, it asserts that Migrator struct implements the Type interface, its implementation is correct (considering the expected return types), and provides the repo.UpMigrator[migrationuc.Settings] interface.
func NewUpMig ¶
func NewUpMig(c *cfg2.Config) repo.UpMigrator[migrationuc.Settings]
NewUpMig creates a Migrator struct wrapping the given Config instance and then uses the Adapt function in order to adapt it to the version independent repo.UpMigrator[migrationuc.Settings] interface.
The Migrator struct is exported and users which need a concrete type can create it directly and wrap the `c` instance. This helper New function is provided in order to combine these two steps (of creation and adaptation) together.
Types ¶
type Adapter ¶
type Adapter struct {
T Type
}
Adapter wraps and adapts an instance of Type in order to provide the repo.UpMigrator[migrationuc.Settings] interface.
func (Adapter) MigrateUp ¶
func (a Adapter) MigrateUp(ctx context.Context) ( repo.UpMigrator[migrationuc.Settings], error, )
MigrateUp calls the wrapped Type MigrateUp method, obtains the next upwards migrator object, and adapts it to the version-independent repo.UpMigrator[migrationuc.Settings] interface using the Adapt function. Since major version 2 has no upper version, this method always returns an error.
func (Adapter) Settler ¶
func (a Adapter) Settler() migrationuc.Settings
Settler calls the wrapped Type Settler method, obtains a C instance, and wraps it by settings.Adapter[C] in order to expose an instance of migrationuc.Settings interface.
type Migrator ¶
Migrator is an upwards Config migrator for *cfg2.Config instances. It wraps a Config struct (with major version 2) and implements the repo.Settler and pkg/adapter/config/settings.UpMigrator generic interfaces.
func (*Migrator) MigrateUp ¶
MigrateUp should migrate the wrapped cfg2.Config instance to its newer version and wrap it by a corresponding upwards migrator. However, since major version 2 has no newer major version, this method always returns an error.
func (*Migrator) Settler ¶
Settler returns the wrapped Config object. After migrating from a source Config version upwards and reaching to an ultimate version, this method reveals the final migrated Config object. This object may have some uninitialized settings too. The MergeConfig method may be used in order to fill them from another Config instance containing the default settings for major version 2.
Source Files