sqlx_core/sqlite/
error.rs

1use std::error::Error as StdError;
2use std::ffi::CStr;
3use std::fmt::{self, Display, Formatter};
4use std::os::raw::c_int;
5use std::{borrow::Cow, str::from_utf8_unchecked};
6
7use libsqlite3_sys::{sqlite3, sqlite3_errmsg, sqlite3_extended_errcode};
8
9use crate::error::DatabaseError;
10
11// Error Codes And Messages
12// https://www.sqlite.org/c3ref/errcode.html
13
14#[derive(Debug)]
15pub struct SqliteError {
16    code: c_int,
17    message: String,
18}
19
20impl SqliteError {
21    pub(crate) fn new(handle: *mut sqlite3) -> Self {
22        // returns the extended result code even when extended result codes are disabled
23        let code: c_int = unsafe { sqlite3_extended_errcode(handle) };
24
25        // return English-language text that describes the error
26        let message = unsafe {
27            let msg = sqlite3_errmsg(handle);
28            debug_assert!(!msg.is_null());
29
30            from_utf8_unchecked(CStr::from_ptr(msg).to_bytes())
31        };
32
33        Self {
34            code,
35            message: message.to_owned(),
36        }
37    }
38
39    /// For errors during extension load, the error message is supplied via a separate pointer
40    pub(crate) fn extension(handle: *mut sqlite3, error_msg: &CStr) -> Self {
41        let mut err = Self::new(handle);
42        err.message = unsafe { from_utf8_unchecked(error_msg.to_bytes()).to_owned() };
43        err
44    }
45}
46
47impl Display for SqliteError {
48    fn fmt(&self, f: &mut Formatter<'_>) -> fmt::Result {
49        // We include the code as some produce ambiguous messages:
50        // SQLITE_BUSY: "database is locked"
51        // SQLITE_LOCKED: "database table is locked"
52        // Sadly there's no function to get the string label back from an error code.
53        write!(f, "(code: {}) {}", self.code, self.message)
54    }
55}
56
57impl StdError for SqliteError {}
58
59impl DatabaseError for SqliteError {
60    /// The extended result code.
61    #[inline]
62    fn code(&self) -> Option<Cow<'_, str>> {
63        Some(format!("{}", self.code).into())
64    }
65
66    #[inline]
67    fn message(&self) -> &str {
68        &self.message
69    }
70
71    #[doc(hidden)]
72    fn as_error(&self) -> &(dyn StdError + Send + Sync + 'static) {
73        self
74    }
75
76    #[doc(hidden)]
77    fn as_error_mut(&mut self) -> &mut (dyn StdError + Send + Sync + 'static) {
78        self
79    }
80
81    #[doc(hidden)]
82    fn into_error(self: Box<Self>) -> Box<dyn StdError + Send + Sync + 'static> {
83        self
84    }
85}
sqlx_core/sqlite/error.rs

sqlx_core/sqlite/
error.rs
