bufmigrate

Documentation

Overview

Package bufmigrate contains logic for migrating between different configuration file versions.

Index

• type Migrator
  • func NewV1Beta1Migrator(commandName string, options ...V1Beta1MigrateOption) Migrator
• type V1Beta1MigrateOption
  • func V1Beta1MigratorWithNotifier(notifier func(message string) error) V1Beta1MigrateOption

Types

type Migrator

type Migrator interface {
	Migrate(dirPath string) error
}

Migrator describes the interface used to migrate a set of files in a directory from one version to another.

func NewV1Beta1Migrator

func NewV1Beta1Migrator(commandName string, options ...V1Beta1MigrateOption) Migrator

NewV1Beta1Migrator creates a new migrator that migrates files between version v1beta1 and v1.

type V1Beta1MigrateOption

type V1Beta1MigrateOption func(*v1beta1Migrator)

V1Beta1MigrateOption defines the type used to configure the v1beta1 migrator.

func V1Beta1MigratorWithNotifier

func V1Beta1MigratorWithNotifier(notifier func(message string) error) V1Beta1MigrateOption

V1Beta1MigratorWithNotifier instruments the migrator with a callback to call whenever an event that should notify the user occurs during the migration.