Struct Migrator 

pub struct Migrator { /* private fields */ }

Upgrades configs through every schema change since their source version.

Implementations

impl Migrator

pub fn new() -> Self

A migrator for the engine, the viewer and the first-party plugins.

pub fn with_plugin(self, plugin: impl PluginMigration + 'static) -> Self

Add the migrations of a third-party plugin.

Panics

When plugin claims a plugin name another migration already owns.

pub fn migrate( &self, kind: Kind, from: Option<&str>, value: Value, ) -> Result<Migrated, MigrateError>

Upgrade value, a kind document, to the current schema.

The release that wrote each object is read from its own version field, falling back to from and then to 2.0.0, so re-migrating an output is a no-op.

Arguments

• kind - Which document value is.
• from - The release that wrote value, as x.y.z, used only when value has no version field.
• value - The config, as JSON.

pub fn step_ids(&self) -> Vec<&'static str>

The id of every step this migrator can run.

pub fn newest_step_version(&self) -> Version

The newest release any step migrates to.

pub fn schema_version(&self) -> Version

The newest release whose configs this migrator accepts.

Trait Implementations

impl Default for Migrator

fn default() -> Self

Returns the “default value” for a type.