Struct migrant_lib::migration::FnMigration

pub struct FnMigration<T, U> {
    pub tag: String,
    pub up: Option<T>,
    pub down: Option<U>,
}

Define a programmable migration

FnMigrations have full database access. Database specific features (d-postgres/d-sqlite/d-mysql) are required to use this functionality. A full re-export of database specific crates are available in migrant_lib::types

Fields

tag: String

up: Option<T>

down: Option<U>

Methods

impl<T, U> FnMigration<T, U> where
    T: 'static + Clone + Fn(DbConn) -> Result<(), Box<Error>>,
    U: 'static + Clone + Fn(DbConn) -> Result<(), Box<Error>>, 

fn with_tag(tag: &str) -> Result<Self>

Create a new FnMigration with the given tag

Tags may contain [a-z0-9-]

fn up(&mut self, f_up: T) -> &mut Self

Function to use for up migrations

fn down(&mut self, f_down: U) -> &mut Self

Function to use for down migrations

fn boxed(&self) -> Box<Migratable>

Box this migration up so it can be stored with other migrations

Trait Implementations

impl<T: Clone, U: Clone> Clone for FnMigration<T, U>

fn clone(&self) -> FnMigration<T, U>

Returns a copy of the value.

fn clone_from(&mut self, source: &Self)

Performs copy-assignment from source.

impl<T: Debug, U: Debug> Debug for FnMigration<T, U>

fn fmt(&self, __arg_0: &mut Formatter) -> Result

Formats the value using the given formatter.

impl<T, U> Migratable for FnMigration<T, U> where
    T: 'static + Clone + Fn(DbConn) -> Result<(), Box<Error>>,
    U: 'static + Clone + Fn(DbConn) -> Result<(), Box<Error>>, 

fn apply_up(&self, _: DbKind, config: &Config) -> Result<(), Box<Error>>

Define functionality that runs for up migrations

fn apply_down(&self, _: DbKind, config: &Config) -> Result<(), Box<Error>>

Define functionality that runs for down migrations

fn tag(&self) -> String

A unique identifying tag

fn description(&self, _: &Direction) -> String

Option migration description. Defaults to Migratable::tag