migrio 1.1.0

A drop-in database migration library for PostgreSQL
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69

/// Error handling for migrations
#[derive(Debug)]
pub enum MigrationError {
    /// An I/O operation failed
    Io(std::io::Error),
    /// A database operation failed
    Database(tokio_postgres::Error),
}

/// Convert `MigrationError` to a string
impl std::fmt::Display for MigrationError {
    fn fmt(&self, f: &mut std::fmt::Formatter<'_>) -> std::fmt::Result {
        match self {
            MigrationError::Io(err) => std::fmt::Display::fmt(err, f),
            MigrationError::Database(err) => std::fmt::Display::fmt(err, f),
        }
    }
}

/// Implement `std::error::Error` for `PoolError`
impl std::error::Error for MigrationError {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            MigrationError::Io(err) => Some(err),
            MigrationError::Database(err) => Some(err),
        }
    }
}

/// Convert `std::io::Error` to `MigrationError`
impl From<std::io::Error> for MigrationError {
    fn from(kind: std::io::Error) -> Self {
        MigrationError::Io(kind)
    }
}

/// Convert `tokio_postgres::Error` to `MigrationError`
impl From<tokio_postgres::Error> for MigrationError {
    fn from(kind: tokio_postgres::Error) -> Self {
        MigrationError::Database(kind)
    }
}

#[cfg(test)]
mod tests {
    use super::*;

    use std::error::Error;

    #[test]
    fn test_migration_error_io() {
        let io_error = std::io::Error::new(std::io::ErrorKind::NotFound, "io error");
        let error = MigrationError::from(io_error);
        let source = error.source().unwrap();
        let message = "io error";
        assert_eq!(format!("{error}"), message);
        assert_eq!(format!("{source}"), message);
    }

    #[test]
    fn test_migration_error_database() {
        let pg_error = tokio_postgres::Error::__private_api_timeout(); // uh oh
        let error = MigrationError::from(pg_error);
        let source = error.source().unwrap();
        let message = "timeout waiting for server";
        assert_eq!(format!("{error}"), message);
        assert_eq!(format!("{source}"), message);
    }
}