sqlite_tiny/api/
query.rs

1//! An SQLite query
2
3use crate::{
4    api::{answer::Answer, types::PointerMut, types::SqliteType},
5    err,
6    error::Error,
7    ffi, Sqlite,
8};
9
10/// An SQLite query
11#[derive(Debug)]
12pub struct Query<'db> {
13    /// The database
14    pub(in crate::api) sqlite: &'db Sqlite,
15    /// The statement
16    pub(in crate::api) raw: PointerMut<ffi::sqlite3_stmt>,
17}
18impl<'db> Query<'db> {
19    /// Binds a value
20    ///
21    /// # Important
22    /// Sadly, unless manually specified with `?NNN`, default column indices for binding start with `1` 😭
23    pub fn bind<T>(self, column: std::ffi::c_int, value: T) -> Result<Self, Error>
24    where
25        SqliteType: TryFrom<T>,
26        <SqliteType as TryFrom<T>>::Error: std::error::Error + Send + 'static,
27    {
28        // Create intermediate value and bind it
29        let value =
30            SqliteType::try_from(value).map_err(|e| err!(with: e, "Failed to convert value into SQLite type"))?;
31        match value {
32            SqliteType::Null => self.bind_null(column)?,
33            SqliteType::Integer(value) => self.bind_integer(column, value)?,
34            SqliteType::Real(value) => self.bind_real(column, value)?,
35            SqliteType::Text(value) => self.bind_text(column, value)?,
36            SqliteType::Blob(value) => self.bind_blob(column, value)?,
37        }
38        Ok(self)
39    }
40    /// Binds a NULL value
41    fn bind_null(&self, column: std::ffi::c_int) -> Result<(), Error> {
42        let retval = unsafe { ffi::sqlite3_bind_null(self.raw.as_ptr(), column) };
43        unsafe { ffi::sqlite3_check_result(retval, self.sqlite.raw.as_ptr()) }
44    }
45    /// Binds an INTEGER value
46    fn bind_integer(&self, column: std::ffi::c_int, value: i64) -> Result<(), Error> {
47        let retval = unsafe { ffi::sqlite3_bind_int64(self.raw.as_ptr(), column, value) };
48        unsafe { ffi::sqlite3_check_result(retval, self.sqlite.raw.as_ptr()) }
49    }
50    /// Binds a REAL value
51    fn bind_real(&self, column: std::ffi::c_int, value: f64) -> Result<(), Error> {
52        let retval = unsafe { ffi::sqlite3_bind_double(self.raw.as_ptr(), column, value) };
53        unsafe { ffi::sqlite3_check_result(retval, self.sqlite.raw.as_ptr()) }
54    }
55    /// Binds a TEXT value
56    fn bind_text(&self, column: std::ffi::c_int, value: String) -> Result<(), Error> {
57        let retval = unsafe {
58            // Bind the text value and instruct SQLite to immediately copy the value
59            ffi::sqlite3_bind_text64(
60                self.raw.as_ptr(),
61                column,
62                value.as_ptr() as _,
63                value.len() as _,
64                ffi::sqlite3_transient(),
65                ffi::SQLITE_UTF8 as _,
66            )
67        };
68        unsafe { ffi::sqlite3_check_result(retval, self.sqlite.raw.as_ptr()) }
69    }
70    /// Binds a BLOB value
71    fn bind_blob(&self, column: std::ffi::c_int, value: Vec<u8>) -> Result<(), Error> {
72        let retval = unsafe {
73            // Bind the blob value and instruct SQLite to immediately copy the value
74            ffi::sqlite3_bind_blob64(
75                self.raw.as_ptr(),
76                column,
77                value.as_ptr() as _,
78                value.len() as _,
79                ffi::sqlite3_transient(),
80            )
81        };
82        unsafe { ffi::sqlite3_check_result(retval, self.sqlite.raw.as_ptr()) }
83    }
84
85    /// Executes the query and gets the next result row if any
86    pub fn execute(self) -> Result<Answer<'db>, Error> {
87        // Create the result object and do a step to make sure the query is actually executed
88        let mut result = Answer { sqlite: self.sqlite, raw: self.raw, has_row: false };
89        result.step()?;
90
91        // Initialize the result struct
92        Ok(result)
93    }
94}