tank-core 0.36.0

Core of Tank: the Rust data layer. This is intended to be used by drivers to implement a backend.
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

use crate::{
    Connection, ConnectionPool, DBConnectionManager, Error, PoolConfig, Prepared, Result,
    Transaction, writer::SqlWriter,
};
use deadpool::managed::Pool;
use std::{borrow::Cow, fmt::Debug, future::Future};

/// Backend connector and dialect.
pub trait Driver: Default + Clone + Sync + Send + Debug {
    /// Concrete connection type.
    type Connection: Connection<Driver = Self> + Debug;
    /// Dialect-specific SQL writer.
    type SqlWriter: SqlWriter;
    /// Prepared statement implementation.
    type Prepared: Prepared;
    /// Transaction implementation.
    type Transaction<'c>: Transaction<'c>;

    /// Human-readable backend name.
    const NAME: &'static [&'static str];

    /// Returns the primary name of the driver.
    fn name(&self) -> &'static str {
        Self::NAME[0]
    }

    /// Creates a new connection to the database at the specified URL.
    fn connect_pool(
        &self,
        url: Cow<'static, str>,
        config: PoolConfig,
    ) -> impl Future<Output = Result<impl ConnectionPool<Self>>> + Send {
        let config = config.into();
        async move {
            Ok(Pool::builder(DBConnectionManager::new(self.clone(), url))
                .config(config)
                .build()
                .map_err(Error::new)?)
        }
    }

    /// Returns a dialect-specific SQL writer for query construction.
    fn sql_writer(&self) -> Self::SqlWriter;
}