Struct Migrator 

pub struct Migrator<S> { /* private fields */ }

Migrator is used to apply database migrations.

When all migrations are done, it can be turned into a Database instance with Migrator::finish.

Implementations

impl<S: Schema> Migrator<S>

pub fn migrate<'x, M>( self, m: impl Send + FnOnce(&mut TransactionMigrate<S>) -> M, ) -> Migrator<M::To>

where M: SchemaMigration<'x, From = S>,

Apply a database migration if the current schema is S and return a Migrator for the next schema N.

This function will panic if the schema on disk does not match what is expected for its user_version.

pub fn finish(self) -> Option<Database<S>>

Commit the migration transaction and return a Database.

Returns None if the database schema version is newer than S.

This function will panic if the schema on disk does not match what is expected for its user_version.