overdrive-db 1.4.0

OverDrive-DB — Embeddable hybrid SQL+NoSQL database. Like SQLite for JSON. #OverDriveDB #AFOT
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
70
71
72
73
74
75
76
77
78
79
80
81
82

//! SDK-specific error types for OverDrive InCode SDK
//! 
//! Provides clean, user-friendly error types that wrap the internal engine errors.

use std::fmt;

/// SDK Result type
pub type SdkResult<T> = std::result::Result<T, SdkError>;

/// SDK Error types — clean, user-friendly errors
#[derive(Debug)]
pub enum SdkError {
    /// Database file not found
    DatabaseNotFound(String),
    /// Database already exists
    DatabaseAlreadyExists(String),
    /// Table not found
    TableNotFound(String),
    /// Table already exists
    TableAlreadyExists(String),
    /// Document/record not found
    DocumentNotFound(String),
    /// Invalid SQL query
    InvalidQuery(String),
    /// I/O error (file operations)
    IoError(std::io::Error),
    /// Serialization/deserialization error
    SerializationError(String),
    /// Constraint violation (unique, foreign key, etc.)
    ConstraintViolation(String),
    /// Transaction error
    TransactionError(String),
    /// Database is closed
    DatabaseClosed,
    /// Security error — key missing, permission denied, injection detected
    SecurityError(String),
    /// Backup error — failed to copy or sync database files
    BackupError(String),
    /// Internal engine error
    Internal(String),
}

impl fmt::Display for SdkError {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            SdkError::DatabaseNotFound(p) => write!(f, "Database not found: {}", p),
            SdkError::DatabaseAlreadyExists(p) => write!(f, "Database already exists: {}", p),
            SdkError::TableNotFound(t) => write!(f, "Table not found: {}", t),
            SdkError::TableAlreadyExists(t) => write!(f, "Table already exists: {}", t),
            SdkError::DocumentNotFound(id) => write!(f, "Document not found: {}", id),
            SdkError::InvalidQuery(q) => write!(f, "Invalid query: {}", q),
            SdkError::IoError(e) => write!(f, "I/O error: {}", e),
            SdkError::SerializationError(e) => write!(f, "Serialization error: {}", e),
            SdkError::ConstraintViolation(c) => write!(f, "Constraint violation: {}", c),
            SdkError::TransactionError(e) => write!(f, "Transaction error: {}", e),
            SdkError::DatabaseClosed => write!(f, "Database is closed"),
            SdkError::SecurityError(e) => write!(f, "Security error: {}", e),
            SdkError::BackupError(e) => write!(f, "Backup error: {}", e),
            SdkError::Internal(e) => write!(f, "Internal error: {}", e),
        }
    }
}

impl std::error::Error for SdkError {}

impl From<std::io::Error> for SdkError {
    fn from(e: std::io::Error) -> Self {
        SdkError::IoError(e)
    }
}

impl From<String> for SdkError {
    fn from(e: String) -> Self {
        SdkError::Internal(e)
    }
}

impl From<serde_json::Error> for SdkError {
    fn from(e: serde_json::Error) -> Self {
        SdkError::SerializationError(e.to_string())
    }
}