Struct ConfigMigrator

pub struct ConfigMigrator<'a> { /* private fields */ }

Struct that contains some configuration on how to migrate a config

let migrator = ConfigMigrator::new("version").with_default_version(0);

let (config, migration_occured) = migrator.migrate::<ConfigV2>(config_str).unwrap();

Implementations

impl<'a> ConfigMigrator<'a>

pub const fn new(version_key: &'a str) -> Self

Creates a new ConfigMigrator using the provided key to find the version of the config

pub const fn with_default_version(self, default_version: i64) -> Self

Adds a default version to use if it cannot be read from the config file

pub fn migrate_config<T: Migrate>( &self, config_str: &str, ) -> Result<(T, bool), Error>

Handles the migration between versions of a configuration

On success, returns a tuple with the config and whether any migrations were performed. Errors if it could not read the version (and no default was provided), if the version failed to match any of the config structs, or if the config file failed to parse.