Struct HistoryFile 

pub struct HistoryFile { /* private fields */ }

A TOML-serializable record of all migrations that have been generated.

The history file lives at <migration_path>/history.toml and is the source of truth for which migrations exist and what order they were created in. Each entry is a HistoryFileMigration.

The file carries a version number. HistoryFile::load and the FromStr implementation reject files whose version does not match the current format.

Examples

use toasty_cli::{HistoryFile, HistoryFileMigration};

let mut history = HistoryFile::new();
assert_eq!(history.next_migration_number(), 0);

history.add_migration(HistoryFileMigration {
    id: 100,
    name: "0000_init.sql".to_string(),
    snapshot_name: "0000_snapshot.toml".to_string(),
    checksum: None,
});
assert_eq!(history.next_migration_number(), 1);
assert_eq!(history.migrations().len(), 1);

// Round-trip through TOML serialization
let serialized = history.to_string();
let restored: HistoryFile = serialized.parse().unwrap();
assert_eq!(restored.migrations()[0].id, 100);

Implementations

impl HistoryFile

pub fn new() -> Self

Create a new empty history file

pub fn load(path: impl AsRef<Path>) -> Result<Self>

Load a history file from a TOML file

pub fn save(&self, path: impl AsRef<Path>) -> Result<()>

Save the history file to a TOML file

pub fn load_or_default(path: impl AsRef<Path>) -> Result<Self>

Loads the history file, or returns an empty one if it does not exist

pub fn migrations(&self) -> &[HistoryFileMigration]

Returns the ordered list of migrations in this history.

Migrations appear in the order they were added. An empty slice means no migrations have been recorded yet.

Examples

use toasty_cli::{HistoryFile, HistoryFileMigration};

let mut history = HistoryFile::new();
assert!(history.migrations().is_empty());

history.add_migration(HistoryFileMigration {
    id: 1,
    name: "0001_init.sql".to_string(),
    snapshot_name: "0001_snapshot.toml".to_string(),
    checksum: None,
});
assert_eq!(history.migrations().len(), 1);
assert_eq!(history.migrations()[0].name, "0001_init.sql");

pub fn next_migration_number(&self) -> u32

Get the next migration number by parsing the last migration’s name

pub fn add_migration(&mut self, migration: HistoryFileMigration)

Add a migration to the history

pub fn remove_migration(&mut self, index: usize)

Remove a migration from the history by index

Trait Implementations

impl Clone for HistoryFile

fn clone(&self) -> HistoryFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for HistoryFile

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

Formats the value using the given formatter.

impl Default for HistoryFile

fn default() -> Self

Returns the “default value” for a type.

impl<'de> Deserialize<'de> for HistoryFile

fn deserialize<__D>(__deserializer: __D) -> Result<Self, __D::Error>

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for HistoryFile

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

Formats the value using the given formatter.

impl FromStr for HistoryFile

type Err = Error

The associated error which can be returned from parsing.

fn from_str(s: &str) -> Result<Self>

Parses a string s to return a value of this type.

impl Serialize for HistoryFile

fn serialize<__S>(&self, __serializer: __S) -> Result<__S::Ok, __S::Error>

where __S: Serializer,

Serialize this value into the given Serde serializer.