Struct Migration

pub struct Migration {
    state: State,
    name: String,
    checksum: u64,
    version: i32,
    prefix: Type,
    sql: Option<String>,
    applied_on: Option<OffsetDateTime>,
}

Represents a schema migration to be run on the database, this struct is used by the embed_migrations! macro to gather migration files and shouldn’t be needed by the user

Fields

state: State

name: String

checksum: u64

version: i32

prefix: Type

sql: Option<String>

applied_on: Option<OffsetDateTime>

Implementations

impl Migration

pub fn unapplied(input_name: &str, sql: &str) -> Result<Migration, Error>

Create an unapplied migration, name and version are parsed from the input_name, which must be named in the format (U|V){1}__{2}.rs where {1} represents the migration version and {2} the name.

pub fn applied( version: i32, name: String, applied_on: OffsetDateTime, checksum: u64, ) -> Migration

pub fn set_applied(&mut self)

pub fn sql(&self) -> Option<&str>

pub fn version(&self) -> u32

Get the Migration version

pub fn prefix(&self) -> &Type

Get the Prefix

pub fn name(&self) -> &str

Get the Migration Name

pub fn applied_on(&self) -> Option<&OffsetDateTime>

Get the timestamp from when the Migration was applied. None when unapplied. Migrations returned from Runner::get_migrations() will always have None.

pub fn checksum(&self) -> u64

Get the Migration checksum. Checksum is formed from the name version and sql of the Migration

Trait Implementations

impl Clone for Migration

fn clone(&self) -> Migration

Returns a copy of the value.

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

Performs copy-assignment from source.

impl Debug for Migration

fn fmt(&self, f: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Display for Migration

fn fmt(&self, fmt: &mut Formatter<'_>) -> Result<(), Error>

Formats the value using the given formatter.

impl Ord for Migration

fn cmp(&self, other: &Migration) -> Ordering

This method returns an Ordering between self and other.

fn max(self, other: Self) -> Self

where Self: Sized,

Compares and returns the maximum of two values.

fn min(self, other: Self) -> Self

where Self: Sized,

Compares and returns the minimum of two values.

fn clamp(self, min: Self, max: Self) -> Self

where Self: Sized,

Restrict a value to a certain interval.

impl PartialEq for Migration

fn eq(&self, other: &Migration) -> bool

Tests for self and other values to be equal, and is used by ==.

fn ne(&self, other: &Rhs) -> bool

Tests for !=. The default implementation is almost always sufficient, and should not be overridden without very good reason.

impl PartialOrd for Migration

fn partial_cmp(&self, other: &Migration) -> Option<Ordering>

This method returns an ordering between self and other values if one exists.

fn lt(&self, other: &Rhs) -> bool

Tests less than (for self and other) and is used by the < operator.

fn le(&self, other: &Rhs) -> bool

Tests less than or equal to (for self and other) and is used by the <= operator.

fn gt(&self, other: &Rhs) -> bool

Tests greater than (for self and other) and is used by the > operator.

fn ge(&self, other: &Rhs) -> bool

Tests greater than or equal to (for self and other) and is used by the >= operator.

impl Eq for Migration