grorm 0.1.1

Goroutine-native ORM for Rust with multi-database support
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
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119

use serde::ser::SerializeStruct;
use serde::{Serialize, Serializer};
use std::fmt;

/// Convenience type alias for `Result<T, Error>`.
pub type Result<T> = std::result::Result<T, Error>;

/// Unified error type for all grorm operations.
///
/// Covers connection, query, protocol, model, pool, and transaction errors.
///
/// # Example
///
/// ```rust
/// use grorm::Error;
///
/// fn example() -> Result<(), Error> {
///     Err(Error::NotFound("user not found".into()))
/// }
/// ```
#[derive(Debug)]
pub enum Error {
    /// Database connection errors (auth, network, etc.)
    Connection(String),
    /// SQL query errors (syntax, constraint violations, etc.)
    Query(String),
    /// SQL execution errors (write operations)
    Execute(String),
    /// Low-level protocol errors (wire format, parsing)
    Protocol(String),
    /// Model serialization/deserialization errors
    Model(String),
    /// Connection pool errors (exhausted, closed)
    Pool(String),
    /// Configuration errors (invalid DSN, etc.)
    Config(String),
    /// Wrapped I/O errors
    Io(std::io::Error),
    /// Entity not found (for operations expecting a result)
    NotFound(String),
    /// Transaction errors (begin, commit, rollback)
    Transaction(String),
}

impl fmt::Display for Error {
    fn fmt(&self, f: &mut fmt::Formatter<'_>) -> fmt::Result {
        match self {
            Error::Connection(msg) => write!(f, "connection error: {}", msg),
            Error::Query(msg) => write!(f, "query error: {}", msg),
            Error::Execute(msg) => write!(f, "execute error: {}", msg),
            Error::Protocol(msg) => write!(f, "protocol error: {}", msg),
            Error::Model(msg) => write!(f, "model error: {}", msg),
            Error::Pool(msg) => write!(f, "pool error: {}", msg),
            Error::Config(msg) => write!(f, "config error: {}", msg),
            Error::Io(err) => write!(f, "io error: {}", err),
            Error::NotFound(msg) => write!(f, "not found: {}", msg),
            Error::Transaction(msg) => write!(f, "transaction error: {}", msg),
        }
    }
}

impl Serialize for Error {
    fn serialize<S>(&self, serializer: S) -> std::result::Result<S::Ok, S::Error>
    where
        S: Serializer,
    {
        // 将 Io 错误转换为字符串
        let (variant, message) = match self {
            Error::Connection(msg) => ("Connection", msg),
            Error::Query(msg) => ("Query", msg),
            Error::Execute(msg) => ("Execute", msg),
            Error::Protocol(msg) => ("Protocol", msg),
            Error::Model(msg) => ("Model", msg),
            Error::Pool(msg) => ("Pool", msg),
            Error::Config(msg) => ("Config", msg),
            Error::Io(err) => ("Io", &err.to_string()),
            Error::NotFound(msg) => ("NotFound", msg),
            Error::Transaction(msg) => ("Transaction", msg),
        };

        let mut state = serializer.serialize_struct("Error", 2)?;
        state.serialize_field("type", variant)?;
        state.serialize_field("message", message)?;
        state.end()
    }
}

impl std::error::Error for Error {
    fn source(&self) -> Option<&(dyn std::error::Error + 'static)> {
        match self {
            Error::Io(err) => Some(err),
            _ => None,
        }
    }
}

impl From<std::io::Error> for Error {
    fn from(err: std::io::Error) -> Self {
        Error::Io(err)
    }
}

impl From<String> for Error {
    fn from(msg: String) -> Self {
        Error::Protocol(msg)
    }
}

impl From<&str> for Error {
    fn from(msg: &str) -> Self {
        Error::Protocol(msg.to_string())
    }
}

impl From<Box<dyn std::error::Error>> for Error {
    fn from(err: Box<dyn std::error::Error>) -> Self {
        Error::Protocol(err.to_string())
    }
}