Struct SnapshotFile 

pub struct SnapshotFile {
    pub schema: Schema,
    /* private fields */
}

A TOML-serializable snapshot of the database schema at a point in time.

Each time a migration is generated, a corresponding snapshot is written alongside it. The next generate run loads the most recent snapshot to compute a diff against the current schema.

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

Examples

use toasty_cli::SnapshotFile;
use toasty_core::schema::db::Schema;

let snapshot = SnapshotFile::new(Schema::default());

// Serialize to TOML via the serde impl
let toml_str = toml::to_string_pretty(&snapshot).unwrap();
let restored: SnapshotFile = toml::from_str(&toml_str).unwrap();

Fields

schema: Schema

The database schema

Implementations

impl SnapshotFile

pub fn new(schema: Schema) -> Self

Create a new snapshot file with the given schema

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

Load a snapshot file from a TOML file

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

Save the snapshot file to a TOML file

Trait Implementations

impl Clone for SnapshotFile

fn clone(&self) -> SnapshotFile

Returns a duplicate of the value.

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

Performs copy-assignment from source.

impl Debug for SnapshotFile

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

Formats the value using the given formatter.

impl<'de> Deserialize<'de> for SnapshotFile

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

where __D: Deserializer<'de>,

Deserialize this value from the given Serde deserializer.

impl Display for SnapshotFile

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

Formats the value using the given formatter.

impl FromStr for SnapshotFile

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 SnapshotFile

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

where __S: Serializer,

Serialize this value into the given Serde serializer.