Struct Migration

pub struct Migration<T> {
    pub from: fn() -> Version,
    pub to: fn() -> Version,
    pub up: fn(&Migration<T>, &mut T) -> Result<(), Box<dyn Error>>,
    pub down: fn(&Migration<T>, &mut T) -> Result<(), Box<dyn Error>>,
}

Fields

from: fn() -> Version

to: fn() -> Version

up: fn(&Migration<T>, &mut T) -> Result<(), Box<dyn Error>>

down: fn(&Migration<T>, &mut T) -> Result<(), Box<dyn Error>>

Implementations

impl<T> Migration<T>

pub fn from(&self) -> Version

pub fn to(&self) -> Version

pub fn change( &self, doc: &mut T, from: &Version, to: &Version, ) -> Result<ChangeResult, Box<dyn Error>>

pub fn migrate_from( from: &Version, to: &Version, doc: &mut T, migrations: &[Self], ) -> Result<bool, Box<dyn Error>>

pub fn migrate( version: &Version, doc: &mut T, migrations: &[Self], ) -> Result<bool, Box<dyn Error>>

Migrate the database schema to the current version. If the version is already the current version, nothing is done. If the version is older, the database is upgraded. If the version is newer, the database is downgraded. Returns true if the database was migrated, false if it was already at the current version.