sqlite-wasm-connector/src/lib.rs

//! Interface to [SQLite][1].
//!
//! ## Example
//!
//! Create a table, insert a couple of rows, and fetch one:
//!
//! ```
//! let connection = sqlite::open(":memory:").unwrap();
//!
//! connection.execute("
//!     CREATE TABLE users (name TEXT, age INTEGER);
//!     INSERT INTO users (name, age) VALUES ('Alice', 42);
//!     INSERT INTO users (name, age) VALUES ('Bob', 69);
//! ").unwrap();
//!
//! connection.iterate("SELECT * FROM users WHERE age > 50", |pairs| {
//!     for &(column, value) in pairs.iter() {
//!         println!("{} = {}", column, value.unwrap());
//!     }
//!     true
//! }).unwrap();
//! ```
//!
//! The same example using prepared statements:
//!
//! ```
//! use sqlite::State;
//!
//! let connection = sqlite::open(":memory:").unwrap();
//!
//! connection.execute("
//!     CREATE TABLE users (name TEXT, age INTEGER)
//! ").unwrap();
//!
//! let mut statement = connection.prepare("
//!     INSERT INTO users (name, age) VALUES (?, ?)
//! ").unwrap();
//!
//! statement.bind(1, "Alice").unwrap();
//! statement.bind(2, 42).unwrap();
//! assert_eq!(statement.next().unwrap(), State::Done);
//!
//! statement.reset().unwrap();
//!
//! statement.bind(1, "Bob").unwrap();
//! statement.bind(2, 69).unwrap();
//! assert_eq!(statement.next().unwrap(), State::Done);
//!
//! let mut statement = connection.prepare("
//!     SELECT * FROM users WHERE age > 50
//! ").unwrap();
//!
//! while let State::Row = statement.next().unwrap() {
//!     println!("name = {}", statement.read::<String>(0).unwrap());
//!     println!("age = {}", statement.read::<i64>(1).unwrap());
//! }
//! ```
//!
//! The same example using cursors:
//!
//! ```
//! use sqlite::Value;
//!
//! let connection = sqlite::open(":memory:").unwrap();
//!
//! connection.execute("
//!     CREATE TABLE users (name TEXT, age INTEGER)
//! ").unwrap();
//!
//! let mut cursor = connection.prepare("
//!     INSERT INTO users (name, age) VALUES (?, ?)
//! ").unwrap().cursor().unwrap();
//!
//! cursor.bind(&[
//!     Value::String("Alice".to_string()), Value::Integer(42),
//! ]).unwrap();
//!
//! cursor.bind(&[
//!     Value::String("Bob".to_string()), Value::Integer(69),
//! ]).unwrap();
//!
//! let mut cursor = connection.prepare("
//!     SELECT * FROM users WHERE age > 50
//! ").unwrap().cursor().unwrap();
//!
//! while let Some(row) = cursor.next().unwrap() {
//!     match (&row[0], &row[1]) {
//!         (&Value::String(ref name), &Value::Integer(age)) => {
//!             println!("name = {}", name);
//!             println!("age = {}", age);
//!         },
//!         _ => unreachable!(),
//!     }
//! }
//! ```
//!
//! [1]: https://www.sqlite.org

extern crate libc;
extern crate sqlite3_sys as ffi;

use std::{error, fmt};

macro_rules! raise(
    ($message:expr) => (return Err(::Error { code: None, message: Some($message.to_string()) }));
);

macro_rules! error(
    ($connection:expr, $code:expr) => (match ::last_error($connection) {
        Some(error) => return Err(error),
        _ => return Err(::Error { code: Some($code as isize), message: None }),
    });
);

macro_rules! ok(
    ($connection:expr, $result:expr) => (match $result {
        ::ffi::SQLITE_OK => {},
        code => error!($connection, code),
    });
    ($result:expr) => (match $result {
        ::ffi::SQLITE_OK => {},
        code => return Err(::Error { code: Some(code as isize), message: None }),
    });
);

macro_rules! c_str_to_str(
    ($string:expr) => (::std::str::from_utf8(::std::ffi::CStr::from_ptr($string).to_bytes()));
);

macro_rules! c_str_to_string(
    ($string:expr) => (
        String::from_utf8_lossy(::std::ffi::CStr::from_ptr($string as *const _).to_bytes())
               .into_owned()
    );
);

macro_rules! path_to_cstr(
    ($path:expr) => (match $path.to_str() {
        Some(path) => match ::std::ffi::CString::new(path) {
            Ok(string) => string,
            _ => raise!("failed to process a path"),
        },
        _ => raise!("failed to process a path"),
    });
);

macro_rules! str_to_cstr(
    ($string:expr) => (match ::std::ffi::CString::new($string) {
        Ok(string) => string,
        _ => raise!("failed to process a string"),
    });
);

/// An error.
#[derive(Debug)]
pub struct Error {
    /// The error code.
    pub code: Option<isize>,
    /// The error message.
    pub message: Option<String>,
}

/// A result.
pub type Result<T> = std::result::Result<T, Error>;

/// A data type.
#[derive(Clone, Copy, Debug, Eq, PartialEq)]
pub enum Type {
    /// The binary type.
    Binary,
    /// The floating-point type.
    Float,
    /// The integer type.
    Integer,
    /// The string type.
    String,
    /// The null type.
    Null,
}

/// A typed value.
#[derive(Clone, Debug, PartialEq)]
pub enum Value {
    /// Binary data.
    Binary(Vec<u8>),
    /// A floating-point number.
    Float(f64),
    /// An integer.
    Integer(i64),
    /// A string.
    String(String),
    /// A null value.
    Null,
}

impl fmt::Display for Error {
    fn fmt(&self, formatter: &mut fmt::Formatter) -> fmt::Result {
        match (self.code, &self.message) {
            (Some(code), &Some(ref message)) => write!(formatter, "{} (code {})", message, code),
            (Some(code), _) => write!(formatter, "an SQLite error (code {})", code),
            (_, &Some(ref message)) => message.fmt(formatter),
            _ => write!(formatter, "an SQLite error"),
        }
    }
}

impl error::Error for Error {
    fn description(&self) -> &str {
        match self.message {
            Some(ref message) => message,
            _ => "an SQLite error",
        }
    }
}

mod connection;
mod cursor;
mod statement;

pub use connection::Connection;
pub use cursor::Cursor;
pub use statement::{Statement, State, Bindable, Readable};

/// Open a connection to a new or existing database.
#[inline]
pub fn open<T: AsRef<std::path::Path>>(path: T) -> Result<Connection> {
    Connection::open(path)
}

/// Return the version number of SQLite.
///
/// For instance, the version `3.8.11.1` corresponds to the integer `3008011`.
#[inline]
pub fn version() -> usize {
    unsafe { ffi::sqlite3_libversion_number() as usize }
}

fn last_error(raw: *mut ffi::sqlite3) -> Option<Error> {
    unsafe {
        let code = ffi::sqlite3_errcode(raw);
        if code == ffi::SQLITE_OK {
            return None;
        }
        let message = ffi::sqlite3_errmsg(raw);
        if message.is_null() {
            return None;
        }
        Some(Error { code: Some(code as isize), message: Some(c_str_to_string!(message)) })
    }
}