Struct ConfigMigrationRule

pub struct ConfigMigrationRule { /* private fields */ }

Rule to migrate deprecated config variables.

Implementations

impl ConfigMigrationRule

pub fn rename_value( old_name: impl ToConfigNamePath, new_name: impl ToConfigNamePath, ) -> Self

Creates rule that moves value from old_name to new_name.

pub fn rename_update_value( old_name: impl ToConfigNamePath, new_name: impl ToConfigNamePath, new_value_fn: impl Fn(&ConfigValue) -> Result<ConfigValue, Box<dyn Error + Send + Sync>> + 'static, ) -> Self

Creates rule that moves value from old_name to new_name, and updates the value.

If new_value_fn(&old_value) returned an error, the whole migration process would fail.

pub fn custom( matches_fn: impl Fn(&ConfigLayer) -> bool + 'static, apply_fn: impl Fn(&mut ConfigLayer) -> Result<String, ConfigMigrateLayerError> + 'static, ) -> Self

Creates rule that updates config layer by apply_fn. match_fn should return true if the layer contains items to be updated.