Struct MigrationState 

pub struct MigrationState { /* private fields */ }

Tracks which migrations have been applied.

This struct provides an in-memory representation of the migration state. In a real application, you would load this from the database using the SQL constants provided in this module.

Example

use oxide_sql_core::migrations::MigrationState;

let mut state = MigrationState::new();

// Check if a migration is applied
assert!(!state.is_applied("0001_initial"));

// Mark a migration as applied
state.mark_applied("0001_initial");
assert!(state.is_applied("0001_initial"));

// Mark a migration as unapplied (rolled back)
state.mark_unapplied("0001_initial");
assert!(!state.is_applied("0001_initial"));

Implementations

impl MigrationState

pub fn new() -> Self

Creates a new empty migration state.

pub fn from_applied(applied: impl IntoIterator<Item = String>) -> Self

Creates a migration state from a list of applied migration IDs.

This is useful for loading state from the database.

pub fn is_applied(&self, id: &str) -> bool

Checks if a migration has been applied.

pub fn mark_applied(&mut self, id: impl Into<String>)

Marks a migration as applied.

pub fn mark_unapplied(&mut self, id: &str)

Marks a migration as unapplied (rolled back).

pub fn applied_migrations(&self) -> impl Iterator<Item = &str>

Returns an iterator over all applied migration IDs.

pub fn applied_count(&self) -> usize

Returns the number of applied migrations.

pub const fn create_table_sql() -> &'static str

Returns the SQL to create the migrations tracking table.

pub const fn insert_sql() -> &'static str

Returns the SQL to insert a migration record.

pub const fn delete_sql() -> &'static str

Returns the SQL to delete a migration record.

pub const fn check_sql() -> &'static str

Returns the SQL to check if a migration is applied.

pub const fn list_sql() -> &'static str

Returns the SQL to list all applied migrations.

Trait Implementations

impl Clone for MigrationState

fn clone(&self) -> MigrationState

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for MigrationState

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

Formats the value using the given formatter.

impl Default for MigrationState

fn default() -> MigrationState

Returns the “default value” for a type.