miden-client-sqlite-store 0.16.1

SQLite-backed Store implementation for miden-client
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

use std::string::{String, ToString};

use rusqlite::Error as RusqliteError;
use rusqlite_migration::Error as MigrationError;
use thiserror::Error;

// ERRORS
// ================================================================================================

/// Errors generated from the `SQLite` store.
#[derive(Debug, Error)]
pub enum SqliteStoreError {
    #[error("Database error: {0}")]
    Database(String),
    #[error("Migration error: {0}")]
    Migration(String),
    #[error(
        "stored schema at version {version} does not match the schema this client builds for that version (expected {expected}, found {actual})"
    )]
    SchemaDrift {
        version: usize,
        expected: String,
        actual: String,
    },
    #[error(
        "store is at schema version {found}, which is newer than the highest version this client supports ({supported})"
    )]
    SchemaTooNew { found: usize, supported: usize },
    #[error(
        "migrating to schema version {version} produced a schema this client does not expect (expected {expected}, found {actual})"
    )]
    MigratedSchemaMismatch {
        version: usize,
        expected: String,
        actual: String,
    },
    #[error(
        "the database is not empty and does not record a schema version, so it was not created by this client and will not be migrated into a store"
    )]
    NotAClientStore,
}

impl From<RusqliteError> for SqliteStoreError {
    fn from(err: RusqliteError) -> Self {
        SqliteStoreError::Database(err.to_string())
    }
}

impl From<MigrationError> for SqliteStoreError {
    /// Renders a migration failure without reproducing the migration script.
    fn from(err: MigrationError) -> Self {
        let message = match &err {
            MigrationError::RusqliteError {
                err: RusqliteError::SqlInputError { msg, .. },
                ..
            } => msg.clone(),
            MigrationError::RusqliteError { err, .. } => err.to_string(),
            MigrationError::ForeignKeyCheck(violations) => {
                format!(
                    "{} foreign key violation(s) after applying the migration",
                    violations.len()
                )
            },
            other => other.to_string(),
        };

        SqliteStoreError::Migration(message)
    }
}